Purpose

Programming projects are assigned to give you practical hands-on experience in writing computer programs and to reinforce the concepts discussed in lecture.
The assignments are designed to:

• introduce you to the Java programming language
• introduce you to Object Oriented Programming
• provoke you to ask questions
• make you think in new and creative ways when solving problems

Assignment Format and Guidelines

Source Code

Modular design mandatory.

Names of variables & methods (functions) should imply usage.

Method parameters should be consistently ordered.

Use standard indentation practices.

Must be easily read by humans, even the instructor.

Internal documentation

• As much as necessary, as little as possible (less = more). Use javadoc formatting conventions.
• Every method (function) needs a one-line (or more) explanation of purpose.
• All variables should be defined, even if self-explanatory.
• Header commentary should include:

  /* CS 127 Bolden         Compiler version           Your Name
   * Date                  Computer & CPU             Your e-mail address
   *
   * Brief description of program/class and objective.
   *---------------------------------------------------------------------
   */
  

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 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 PrintScreen of compiler error message(s).
• Bring outline/flowchart/pseudocode of program design, indicating
  where you believe the problem is occurring.
• Bring hard copy of current source code.