The following highlights common deficiencies which leadto loss of credit in Programming Projects. Review this sheet before turningin each Programming Project to make sure that the project is complete inall respects.
I. Quality of the Source Code
A. Variable Names Use variable names with a clear meaning in the context of the program whenever possible.
B. Format Include adequate white-space in the program to improve readability. Insert blank lines to group sections of code. Use indentation to improve readability of control flow. Avoid confusing use of opening/closing braces.
C. Internal Comments Main program comments should describe overall purpose of the program. Function comments should describe their purpose and other pertinent information, if any. Compound statements (control flow) should be commented. Finally, see that commenting is not overdone and redundant.
D. Modularity in Design Avoid accomplishing too many tasks in one function; use a separate module. Also, avoid too many lines of code in a single module; create more modules. Design should facilitate individual module testing. Use automatic variables instead of external variables whenever possible. Use separate header files and implementation files for unrelated classes.
A. Correctness of Output Ensure that all outputs are correct. Incorrect outputs can lead to substantial loss in credit.
B. Ease of Use The program should facilitate repeated use when used interactively and should allow easy exit. Requests for interactive input from the user should be clear. Incorrect user inputs should be captured and explained. Outputs should be well-formatted.