Documentation



next up previous contents
Next: Reference to Files Up: Standards and Tips Previous: Formatting

Documentation

It is advantageous to have a documentation particularly when more people work with macros but also when there are so many macros that it is very difficult to keep track.

As described in chapter 'Basics' each line starting with a '#' can be used as comment line.

It is recommended to document complex algorithms or other important facts in this way.

The comprehensiveness of the documentation is a question of personal preferences and the time available for this job. The topic however should not be neglected.




Thu Aug 3 12:51:32 MET DST 1995