gtpa2m3uApplication Programming

Program Commentary

Emphasize good programming commentary. It serves the dual purpose of explaining how the program works and communicating expected interfaces with other programs.

As suggested earlier, application designers should develop conventions about the use of common system resources, such as data levels, the ECB work area, and shared interface records such as the routing control block and the scratchpad area. Whether or not by convention, program commentary must specify expected interfaces: the expected condition of common system resources at the time the program is activated and when it passes control to other programs. The program listing should contain clear, concise comments throughout. When modifying existing code, ensure that comments remain meaningful.