CECS 274 Programming and Problem Solving II
Program Documentation
Documenting programs is an essential component of writing good code.
When documentation is done correctly (and before the actual code is written)
it is part of the design process that helps programs to satisfy their
specifications.
The documentation model we will use is as follows:
I. An initial comment for each C++ class or program containing the
following information:
A. Purpose
B. Author and date
D. Major algorithms and data structures used
C. Input and output
E. Exceptions or what could go wrong
II. Initial comments in each function of the class that include:
A. Purpose
B. Preconditions
C. Postconditions
D. Functions called (if any)
III. Comments in the body of each function to explain difficult code or
subtle logic.
The design-level program documentation of items I and II should be
completed before any C++ code is written. Item III will be written at the
time of coding.
Dr. Tracy Bradley Maples (Modified form Carrano, Helman and Veroff, p. 39)