Program documentation can include narrative descriptions of what the program does, and why maintenance has been carried out. The narrative descriptions are extracted from special comment lines in the source: they thus stand a good chance of staying up to date.
The special comment lines can be used in all types of source. Four types of documentation comment lines are catered for:
Program descriptions can be written ahead of the program, so that they serve as program specifications. If programmers fail to provide even a basic description of their programs, the program documenter makes the fact obvious, and so helps you control the quality of your documentation.
For example, the marked comments from the CL program shown following in the first diagram, would be summarized as shown in the diagram that follows it:
|
Copyright © 2014 CA.
All rights reserved.
|
|