Programming Style and Documentation

• Identifiers must be chosen to reflect their functions in the program. For each identifier, note its function with a comment in the heading remarks.
• Output must be labeled and in an easily readable format; input should always be echoed and labeled for the sake of validity.
• A brief paragraph should be included in the beginning of the program, each class, and each method within the class describing what the program or method does and how it is to be used or, in the case of a class, what is modeled by the class. The prologue comments for methods must include invocation assumptions and a description of the arguments (if any). Comments should be included at key locations within the program to explain what is being done. All comments must be on a higher level of abstraction than the statements which they explain; avoid redundancy.
• The program should be indented and formatted for maximal readability by a human.