Artikel

Mit “HeaderDoc” bietet die Jobs-Company ein quelloffenes Code-Dokumentations-Tool, das in Perl geschrieben ist und zahlreiche Programmiersprachen unterstützt. 

Mit Hilfe von HeaderDoc können Entwickler Programmcode auf einheitliche und professionelle Weise dokumentieren. Die Palette an unterstützten Programmiersprachen ist breit und reicht von Skriptsprachen wie PHP, JavaScript und AppleScript bis hin zu etablierten Hochsprachen wie Java, C, C++, Objective-C, Python und Ruby. Das Tool wurde ursprünglich für den Mac konzipiert. Da es aber auf Perl basiert, kann es auf jeder beliebigen Plattform laufen, die diese Programmiersprache unterstützt.

Die Installation ist denkbar einfach: Entwickler, die auf dem Mac arbeiten, finden das Werkzeug unter den Mac OS X Developer Tools. Ansonsten kann das Programm von Apples Website kostenlos heruntergeladen wurden. Neben den eigentlichen Skripts, die verschiedene Funktionen rund um die automatische Code-Dokumentierung implementieren, finden sich im Installationspaket Code-Beispiele und eine ausführliche Benutzerführung, die den Einstieg erleichtern. Wie bei den meisten Lösungen dieser Art erfolgt die Dokumentation direkt im Programmcode. Dabei ist die Syntax von HeaderDoc dem JavaDoc-Standard sehr ähnlich (@author, @param, und so weiter), bietet aber einige zusätzliche Regeln, die für mehr Kontrolle im Dokumentationsprozess sorgen. Mit dem Perl-Skript “headerdoc2html” wird aus den Kommentaren im Quelltext die Dokumentation im HTML-Format erstellt. Mit “gatherHeaderDoc” werden die einzelnen Dokumentationsseiten zusammengefasst und ein Inhaltsverzeichnis automatisch generiert. Zudem kann die Dokumentation als XML exportiert werden.

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 ihn ist das Tool eine interessante Alternative.