Programming Guidelines

 

 

Original Code

All programs must have the following information in the header of the program using comment commands appropriate for the software language:

 

5             Programmer name	5             Brief code description (i.e., one to two sentences that explains why the program is used and what it will process)	5             Original program name
5             Original programmed date	5             List the Use Case(s) from the design document that will be impacted by this program	5             Copyright statement
5	5	5

 

 

Although not required, it is preferable for comment statements to be used in the code to explain the major processing statements (or combination of those statements).  These could be used before declarations of interfaces, programming logic, key functions, and fields.

 

 

Modifications

Any modifications to the code will also be documented in the header of the program under the Original Code Header Information listed above.  The following documentation guidelines are required:

 

5   Programmer Name

5   Modification Date

5   Brief modification description