The cover page should these items:

• Title of the assignment
• Student name
• Section number
• Assignment/Lab number
• Date

The Summary section of the report is an informational section that simply states what you learned while doing the assignment, as well as any problems you encountered while trying to complete it. Your summary of these points may be as verbose or concise as you like, though at the very least you should state that you had no problems. Assuming you feel your report looks good with this information on the front page, you may place it there. If you have a lot to say on the matter, you can place this information on a separate page, but it should be toward the beginning of the report and not buried in the midst of source code. If you are unable to implement all of the functions or functionality of the assignment, please specify which functions or requirements are incomplete. If certain functions cause program errors, please insert comments above these functions indicating that they cause errors and comment out any lines in the remaining program that call these functions. Additionally, please comment out the problem functions themselves. By doing this, you remove the non-functional parts of your program and can earn points for the functional aspects of the program.

A brief description of the assignment and the requirements that your program must satisfy. This should be followed by a short explanation of what your program does and thus how it fulfills the program requirements. If your program falls short of any of the requirements for the assignment, please make a note of it here.

This section should contain a description of the program design and algorithms that were implemented. Additionally, a description of each function in your program, in the style presented in the textbook on page 477, is required, though do not include code. These should not be low-level descriptions that detail how every parameter is handled (that's what source code function comments are for), but rather high-level descriptions of what each function does.

A printed copy of the source code for your program, complete with function and class documentation.

A printed copy of the screen output showing that your solution to the assignment is both correct and operational.

Code commenting allows others to understand the overall flow of your program, as well as the operation of each functional unit. Each function, class, and noteworthy program unit should have some description of what is does and how it works. Line comments are also encouraged, but be careful not to comment every line unless it is necessary (e.g. you made cryptic code). Functions should be commented in such a way that their purpose is made clear. At the very least, include a one-line description of the purpose of the function. You might consider a form of documentation similar to the following documentation block, which is the standard for the course: Each file of the assignment should have a description of what the file contains, the author of the program, the date, and any other information relevant to its contents. The standard for the course is to place the following comment block at the beginning of each file of your project:

The flow of the program should be as clear as possible. Code should be properly indented and blank lines used to promote readability. Variables should be appropriately named so as to make their function clear. Please do not try to write particularly efficient code at the expense of readability. The purpose of these assignments is to get students to understand the programming concepts, not write the fastest code possible. While your code should be as compact as possible, it should not compromise understanding. For example, please do not replace typical if-else blocks with the shorthand, one-line if-else syntax.

Please make sure that the assignment compiles without critical errors and runs as it should. Programs that do not compile or execute will be given an immediate zero.