Programming projects are assigned to give you practical hands-on experience in writing computer programs.
They are designed to challenge you:
- to be introduced to a programming language (C++)
- to ask questions
- to think in new and creative ways when solving problems
Source Code
Your source code (program):The source should be organized as described in the program organization page. Must be easily read by humans, even the instructor. Use standard indentation practices. Names of variables & procedures should imply usage. Modular design mandatory. Function parameters should be consistently ordered. Internal documentation (Comments)
As much as necessary, as little as possible (less = more). Comments should enhance the
understanding of your program and should clarify what you are doing in the code.Header commentary should include:
/* progName.cpp * * CS 112.Bolden.........Compiler version...........Your Name * Date .................Computer & CPU.............Your email address * * Brief description of program and objective. *--------------------------------------------------------------------- */This header format facilitates grading and describes what the purpose of the program.All variables should be defined, even if self-explanatory.
Every procedure/function needs a one-line (or more) explanation of purpose.Input Files
Identify any additional files (by filename.ext) that were used.Output
Should be self-explanatory (reader need not refer to source code).Title Raw & computed data, displayed in easily readable format. Name of programmer, and date of completion. Turning assignments in for Grading
Staple all pages together. Fold lengthwise, put Your Name/Class/Date on outside. Arrange pages so source appears first, input file next, then output. Bringing problems to the instructor (or a consultant)
Eliminate all code except the module containing the error & driver. Bring a listing of compiler error message(s), mark cursor position. Bring outline/flowchart/pseudocode of program design, indicating where you believe the problem is occurring. Bring hard copy of current source code. Be prepared to explain what the error is and how you have tried to fix it.