Documentation

 

Approaches of modern software documentation

In the development work, we set value on the neat documentation of the program source code. The identifiers of variables, classes and methods are self-explanatory. The structure becomes sufficiently apparent through adequate indenting and unindenting of control structures.

 

Annotation of the source code

The documentation is included in the source code as far as possible. This happens through comment lines which are positioned in close proximity to the correspondent orders in the source code and which are updated immediately in the case of a change of the orders.

 

Supplementation of the annotation

If notes, sketches and such cannot be integrated directly in the source code, they are filed away separately and distributed together with the source code files, so that they are available for all developers and no inconsistencies come up.