Report: Comment Documentation from Source Code |
Option: -C |
Compatible Options: RSM Option Cross Reference |
Usage: rsm -H -O report.htm -C *.h *.cpp rsm -H -O report.htm -C *.java |
Source: C, C++ and Java |
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. |
File: cell.h Date: Sun Jun 27 08:08:58 1999 File Size: 762 Bytes ________________________________________________________________________ 1: // cell.h 2: // 3: // Specification for type cell 4: // A cell is a piece of an ocean 5: // Class: Cell ------------------------------------------------------------------------ 16: // assigned to the cell 19: // depth of the ocean 22: // constructor 23: // copy constructor 24: // destructor 34: // CELL_H ________________________________________________________________________ End of File: cell.h |