Comments & Strings
Comments & Strings
| Report: Extraction of Comments and Literal Strings |
| Option: -E |
| Option Parameters: -Es Extract Literal String -Ec Extract Comments -EC Extract Comments relative to the files and functions |
| Compatible Options: RSM Option Cross Reference |
|
Usage: |
| Source: C, C++, C# and Java |
|
Extracting
literal strings -Es and comments -Ec to a source
code-less file allow the generated report to be spell checked by
Microsoft
Word or your favorite spell check program. The extraction report
identifies
literal strings or comments relative to the file and the physical
line. When a spelling error is identified by your spell checker it is
easy to
locate the defect in the source code. -EC was -C in versions preceeding 7.00. RSM extracts comments from each source file and emits them relative to files, classes and functions. Each comment is emitted with the line number location from the source file. This report details how well the source code is commented. If you can read the report like a story of the source code then the PDL or comments properly describe the functionality of each file or module. PDL or Program Definition Language are comments that are created for the design phase. PDL should be the voice of the program independent of the source code. |