Documentation See the Documentation Standards document for a description and example of program headers and for a description of code documentation. In addition to the comments inside a program, you should create a User's Guide which gives the name of the program, directions for using it, a short description of the purpose of the program, your name, the date when you wrote the program, and dates and comments on any subsequent modifications you wrote. Good formatting can make a program far easier to understand. White space is essential for clarity. This includes spaces around identifiers, operators, at the beginning and end of comments, as well as blank lines, especially to separate blocks and different sections of blocks.
Consistent indentation is essential for readability.
Indentation should be used to indicate that the indented statements are under the control of the previous non-indented statement . Use this as a test when deciding to indent. Try to avoid statements that take more than one line. Then the block can be scanned easily for content, coherence, use of variables, etc. Choose names for your variables and other identifiers that are meaningful in the context of their use.