Introduction |
Understand for Ada offers a number of ways to cross reference Ada language items, for instance Packages, Functions, and Types. However, what about other things you may wish to keep track of, such as:
- Requirements - tracing requirements to implementation or designAnd of course a number of other things.
Mark Reports offer a way to define what you want to cross reference and to then store information in the source code (where it is easy to maintain).
The premise behind Mark Reports is that your source code is a good spot to document things about itself. To create a Mark Report simply place a comment of this form:
--+ mark_report_name mark_value [optional mark text to end of line]will result in a report structured as:
TBDThis type of marks setup would permit a report listing requirements and where they were met:
Package List isUnderstand for Ada fully supports old ADADL style marks (--&, --$, etc...). There is no need to retro-fit existing ADADL supported code. As such, this manual won't cover how to setup ADADL marks as we prefer that the new method described above be used in new code. If you need to know how ADADL marks work because you have inherited code that has them in it, consult the ADADL manual, or contact STI technical support.
Scientific Toolworks, Inc. http://www.scitools.com Voice: (802) 763-2995 Fax: (802) 763-3066 support@scitools.com sales@scitools.com |