Module Header

The module header is the comment at the top of a .h or .c file. Information need not (except for the title) be repeated in both the .c and .h files. Of course History sections are separate. See a dummy example. Note:-

Heading: To make it easy to spot the file in a long listing, put a header and te file name in the top right-hand corner.
Authors: Just a list to make the initials intelligible. Use initials in the history or in comments in the file.
History: A list of major changes of the file. You do not need to repeat information carried by a code management system or in an accompanying hypertext file.
Section headings: Sections in the file such as public data, private module-wide data, etc should be made visible. Two blank lines and a heading are useful for this.

_________________________________________________________________

Tim BL