|
6.1. Wesentliche Passagen
Die wichtigsten Teile, die es zu dokumentieren gilt, sind diejenigen, welche die meisten Teile des Programmes beeinflußen. Daher ist es wesentlich, daß jede Prozedurschnittstelle, jede Strukturdeklaration und jede globale Variable klar dokumentiert wird. Wenn Du eines dieser Teile nicht dokumentiert hast, dann ist es notwendig jedes Vorkommen des nicht dokumentierten Teiles zu sichten und herauszufinden, wie es funktioniert; dies ist sehr zeitaufwendig und fehlerträchtig.
Auf der anderen Seite benötigen Quelltextteile mit nur lokalem Bezug keine umfassende Dokumentation. Wenn die generelle Funktion der Prozedur erklärt wurde, und es nicht sehr viel Quelltext in der Prozedur gibt, und wenn die Variablen sprechende Namen haben, dann wird es einfach sein herauszufinden, wie sie verwendet werden. Bei langen Prozeduren hingegen, mit vielen Variablen, sollten zumindest die wichtigsten Variablen beschrieben werden. *
* Diesen Teil hat der Übersetzer bewußt gekürzt, weil darin vom Verfasser einige Punkte aufgeführt sind, die der Übersetzer für nicht sinnvol erachtet. Damit wurde der Diskussion schon ein wenig vorgegriffen. Es geht darum, daß der Verfasser bei kleinen Prozeduren auf die Dokumentation von Variablen völlig verzichten will. Gerade bei kleinen Prozeduren mit wenigen Variablen ist der Aufwand einer Dokumentation so gering, daß hier kein Grund für eine derartige Sparsamkeit bestehen kann. Ansonsten besteht die Gefahr, daß generell auf derartige Dokumentationen verzichtet wird, weil in einem Entwicklerteam Uneinigkeit darüber bestehen kann, ab welcher Größe eine Prozedur als klein angesehen wird, so daß eine saubere Dokumentation entfallen kann.
|