Recommended Format for Document Files

To make document files more readable, we recommend using the following format guidelines:

1.  Place a long line(s) of comment text at the beginning of each module to easily identify the start of a new module:

{===================== System\Graphics =======================}

{ This module handles all of the graphics for the application }

 {=============================================================}

Place a similar line of text at the end:

{ End of System\Graphics }

2.  Place all module and state names at the left margin.

3.  Indent variable and parameter declarations 2 spaces.

4.  Indent all statements and actions 2 spaces.

5.  Indent all scripts 4 spaces.

6.  Put a space between all parameters and before and after all operators.

7.  Place comments liberally to describe the purpose of each variable and module.

Using these recommendations as a guide will help you to produce documents that are easy to read, both for yourself, as well as for other programmer who may review and build upon your code.