Function Headings

This style concerns the comments, and so is not essential to compilation. However, it helps readability of code written by a number of people. Some of these conventions may be arbitrary, but are none the less useful for that.


See a sample procedure heading . Note:-

Entry and exit condidtions

It is most important to document the function as seen by the rest of the world (especially the caller). The most important aspects of the appearance of the function to the caller are the pre- and post-conditions.

The pre conditions include the value of the parameters and structures they point to. Both include any requirements on or changes to global data, the screen, disk files, etc.


Tim BL