Jeder Softwareentwickler kennt das Problem: Die Software ist fertig gestellt und der Sourcecode ist adäquat dokumentiert. Eigentlich prima, oder? Nun aber kommen Änderungen und Nachbesserungen. Dabei werden Schnittstellen verändert, neue Parameter kommen hinzu bzw. obsolete Parameter werden entfernt. Dadurch ist die bisherige Sourcecode-Dokumentation nicht mehr aktuell. Das Anpassen der Dokumentation wird entweder ganz vernachlässigt oder ist wenigstens sehr aufwändig.

In diesem Artikel möchte ich von einer Möglichkeit berichten, wie man SAS-Programme so dokumentieren kann, dass sich unter Verwendung des freien Tools Doxygen jederzeit eine aktuelle Sourcecode-Dokumentation generieren lässt. Doxygen bietet viele unterschiedliche Ausgabeformate zur Auswahl, wobei HTML das wohl gängigste ist.

Doxygen (http://www.doxygen.org) ist ein frei erhältliches Dokumentationssystem (GNU General Public License), welches eigentlich für C++ und Java optimiert ist. Wenn Sie sich nach einer Testphase für Doxygen entscheiden, sollten Sie die Entwickler mit einer Spende unterstützen („Donate“ auf der Website).

Um eine automatisierte Programmdokumentation zu erhalten, sollten folgende Punkte beachtet werden:

• Jedes SAS-Programm wird in einer separaten Datei gespeichert.
• Zu Beginn jeder Datei befindet sich der Dokumentationsblock.
• Der Dokumentationsschritt wird in Doxygen konfiguriert und lässt sich, per Batch-Aufruf, jederzeit durchführen.

Der vorliegende Artikel beschreibt:

• Wie Doxygen für die Dokumentation von SAS-Programmen konfiguriert wird,
• wie man Kommentare in den SAS-Code schreibt, damit diese von Doxygen verarbeitet werden können,
• wie man Doxygen startet, um die Dokumentation zu erzeugen.
• Beigefügt ist ein kleines Beispielprojekt zum Download, anhand dessen die Funktionsweise von Doxygen schnell nachvollzogen werden kann.

Das hier beschriebene Verfahren hat mir bereits in mehreren Projekten gute Dienste geleistet.