All source code submitted to Dr. Taylor should meet the minimum
documentation standards outlined below.
- The beginning of each source file should contain:
- The name of the file.
- A short description of the purpose of the code contained in the file.
- The date it was originally written.
- The original author.
- A modification log (when appropriate) which describes:
- What modifications were made.
- When the modifications were made.
- Who made the modifications.
- Each function prototype should contain the following documentation:
- What the function does.
- The parameters passed in the formal argument.
- What the function returns (if anything).
- The following documentation should precede each function body:
- Who wrote the function.
- When the function was written.
- Any sources other than the author (Web URL, fellow student, etc.)
that aided in the design of the function (and what aid was
- A modification log (when appropriate) for the function.
- Within each function, documentation should be provided for any
code whose purpose is not immediately obvious to someone with your
current level of programming knowledge.
The war card game code (PDF) provides
an example of C++ source code which meets my minimum documentation