SPECIAL NOTES FOR ALL ASSIGNMENTS In assignments involving coding, you should include documentation in your source code files in the form of comments. When you modify existing programs, you should get into the habit of including comments that denote what sections of code you have personally modified. Each file you submit must contain a header with the following information: Your name Section # (if this applies) Filename Assigment number Date Description -- (A brief description of the file and its purpose) Example: /////////////////////////////////////////////////////// // Name: Bob Myers // Section: 4 // File: digitime.cpp // Asg: #1 // Date: 5/13/98 // Purpose: // This file contains the definitions of the functions // declared in DigiTime.h // // Modified by Bob - Timer class modified to include seconds /////////////////////////////////////////////////////// You should always document any changes you make to somebody else's original code, either in the header, or next to the changes themselves. Example: // Function added by Joe Schmuckatelli -- 5/14/98 void Function(yadda, yadda) { yadda; yadda; } // End added Indentation should be consistent and should make the program easier to read. Comments and documentation should clarify your code. It is a good idea to include comments on each function definition, on declarations, and inside of larger pieces of code to help clarify what is happening, or to break things into logically coherent pieces.