Kleine Helfer

Quelloffenes Tool für die Codedokumentation

Diego Wyllie hat Wirtschaftsinformatik an der TU München studiert und verbringt als Softwareentwickler und Fachautor viel Zeit mit Schreiben – entweder Programmcode für Web- und Mobile-Anwendungen oder Fachartikel rund um Softwarethemen.
Mit Hilfe von "HeaderDoc" können Entwickler Programmcode auf einheitliche und professionelle Weise dokumentieren.
Codedokumentation mit HeaderDoc.
Codedokumentation mit HeaderDoc.
Foto: Diego Wyllie

Unterstützt werden dabei Skriptsprachen wie PHP, Javascript und Applescript bis hin zu etablierten Hochsprachen wie Java, C, C++, Objective-C, Python und Ruby. Das kostenlose Tool wurde für den Mac konzipiert, läuft aber auf jeder beliebigen Plattform, die Pearl unterstützt. Entwickler, die auf dem Mac arbeiten, finden das Werkzeug unter den Mac-OS-X-Developer-Tools. Ansonsten kann das Programm von Apples Website kostenlos geladen werden.

Neben den eigentlichen Skripts, die verschiedene Funktionen rund um die automatische Codedokumentierung implementieren, enthält das Installationspaket Codebeispiele und eine ausführliche Benutzerführung. Die Dokumentation erfolgt direkt im Programmcode. Dabei ist die Syntax dem Javadoc-Standard sehr ähnlich (@author, @param und so weiter), bietet aber zusätzliche Regeln für mehr Kontrolle im Dokumentationsprozess.

Mit dem Perl-Skript "headerdoc2html" wird aus den Kommentaren im Quelltext die Dokumentation im HTML-Format erstellt. Mit "gatherHeaderDoc” werden die Dokumentationsseiten zusammengefasst und ein Inhaltsverzeichnis erzeugt. Zudem kann die Dokumentation als XML exportiert werden.

CW-Fazit: HeaderDoc ist ein mächtiges Dokumentations-Tool, von dem nicht nur Mac-Entwickler profitieren können. Wer Software-komponenten in verschiedenen Sprachen einheitlich dokumentieren möchte, für den ist das Tool eine interessante Alternative.