Kleine Helfer

Einheitliche Codedokumentation mit NaturalDocs

06.07.2010 | von 
Diego Wyllie
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.
Email:
Mit "NaturalDocs" lassen sich Quelltextdateien, die in verschiedenen Programmiersprachen geschrieben sind, auf einheitliche und konsistente Weise dokumentieren.
Aus Codekommentaren, die mit einer einfachen Syntax geschrieben werden, generiert NaturalDocs automatisch die Softwaredokumentation im HTML-Format.
Aus Codekommentaren, die mit einer einfachen Syntax geschrieben werden, generiert NaturalDocs automatisch die Softwaredokumentation im HTML-Format.

Java-Programme lassen sich optimal mit JavaDoc dokumentieren. Für andere objektorientierte Sprachen wie C++ oder Ruby gibt es entsprechende Tools, die ebenfalls gute Arbeit leisten. Aber wie dokumentiert man Javascript-, XML- oder einfache, aber wichtige Konfigurationsdateien? Wie erstellt man bei Projekten, in denen verschiedene Programmiersprachen zum Einsatz kommen, eine einheitliche und konsistente Codedokumentation? Eine mögliche Antwort auf diese Fragen lautet NaturalDocs.

Dabei handelt es sich um ein quelloffenes, in Perl geschriebenes Kommandozeilenprogramm, mit dem eine ganze Reihe von Programmiersprachen dokumentiert werden können - unter anderem Java, C#, C++, Ruby, Python, PHP, Pascal, ActionScript und Javascript. Praktisch an dem Tool ist, dass die Dokumentation sehr nahe an der natürlichen Sprache ist. Die Syntax ist möglichst einfach gehalten (siehe Screen) und lässt sich in kurzer Zeit erlernen. Die Ausgabe der Quellcode-Dokumentation erfolgt im HTML-Format - mit oder ohne Frames. Zudem lassen sich NaturalDocs-Skripte leicht in Build-Tools wie Ant integrieren, um etwa bei Build- oder Deploy-Tasks den Code automatisch zu dokumentieren.

CW-Fazit

Mit NaturalDocs lassen sich Softwareprojekte, in denen verschiedene Programmiersprachen eingesetzt werden, auf einheitliche und konsistente Weise dokumentieren. Die natürlichsprachige Syntax und die Unterstützung von JavaDoc sorgen für einen leichten Einstieg.

Newsletter 'Software' bestellen!