Hi,
I am working on a iOS application for a medical device company. Just like for any software project we have design requriements and design specification. Additionally, since our app will fall under FDA's rules, we have some extra work to do in this area. One of the things we would like to do have some kind of way in Xcode to be able to link specific source files, classes, methods, etc. to design requirements... for example:
Design Requirement # 1:
User must be able to signup through our app and credential are generated on ther sever
Related Source Files / Classes / Methods to fulfill design requirements
TextInputValidation.swift
validateUserEmail ( )
validateUserPassword ( )
registerUser( )
I'm fairly new to this and still researching this, but is there a way, to do this in Xcode or some other tool? Currently, I am thinking about just adding comments inside class files at the top or for a method with someting like "DR001" or something, but if someone has come accross a more elegant and purpose built solution. Our project manager and I myself would like to have a cool way to do this... I was thinking about building an Xcode Source Editor extension for this, but I dont know if a source editor extension makes sense?
Thanks!
I do not know such tool in XCode.
At minimum, you could create comment template for each function and include the template in the Project templates (button next to inspectors).
I use this simple structure:
// --------------------- windowDidLoad ---------------------------------------------------------------
// Description: handle any initialization after your window controller's window has been loaded from
// its nib file.
// Parameters
// None
// Comments
// -------------------------------------------------------------------------------------------------
You could add a specific line for reference to requirements.
That would allow you to search for all func that are linked to a requirement.
The "Find Call hierarchy" in Find menu may also help you here.
