brentwoodhigh.com

The top of each source file should contain:

1. First and Last Name
2. Description of the Program
3. Starting Date
4. Location of the completed program - user drive, local computer, external drive, home computer)
5. Contributors to the Program - List the name of those who have assisted with a general statement of where help was received. INCLUDE all that assist. What is a Contributor?

Source Code Documentation

1. comment following each brace } indication which block is closed. Examples :

} //end while
} // end for i
} // end main
} // end calcAvg

2. functions in C++

Short description of the function is intended to accomplish.
Any preconditions - we will assume the precondition - arguments are not uninitialized variables.
Post conditions - Changes in the calling function other than what is returned by the function.
Expected framework for a function's IDOC

//Desc -
//Pre -
//Post -

3. Sample Output

Sample output is required most programs. Sample output should be copied and pasted as a comment after the closing brace of the main function.
If the program outputs to a file containing more than 15 lines a path to the output file is required.