Schneller und effizienter entwickeln – mit Javadoc

Bekanntlich ist die Dokumentation ein entscheidender Bestandteil jedes Softwareprojekts. Sie wird während der Erstellung verwendet und sollte darüber hinaus die Pflege der Software ermöglichen. Leider kann das Erstellen der Dokumentation zeitaufwendig und komplex sein, weshalb viele Entwickler diese Aufgabe nur unwillig angehen, was wiederum zu einer unvollständigen Dokumentation führt, die nicht mit den laufenden Modifikationen Schritt hält.

Die Quellcode-Dokumentation ist ein wichtiger Bestandteil des gesamten Dokumentationsprozesses – und genau hier kann einem das Javadoc-Tool helfen. Zusammen mit einem simplen Texteditor und einer durchdachten Projektverzeichnisstruktur kann dieses Tool die Code-Dokumentation beschleunigen und verbessern.

Projektverzeichnisstrukturen

Ein normales Softwareprojekt verfügt über einen Satz von Dokumenten (Anforderungen, Spezifikationen, Tests sowie ein Integrationsplan), mit dem der Systementwickler arbeiten muss. Außerdem muss er auf diese Dokumente ohne Umstände zugreifen und sie pflegen können. Hier eine typische Verzeichnisstruktur, wie sie für ein Projekt geeignet ist:

Das Verzeichnis /classes enthält die kompilierten Java-Klassendateien, /doc die Dokumentation, /resources die Projektressourcen, /spec die Projektdokumentation und /src die Java-Quelldateien. Die Datei spec.html dient der Zuordnung, worauf weiter unten noch genauer eingegangen wird.

Die Verzeichnisstruktur kann auch wie folgt angelegt werden, wobei die projektbezogene Dokumentation eine Ebene höher platziert wird als der Quellcode.

Der Vorteil dieser Struktur besteht darin, dass sie eindeutig verpackt und damit vom Verzeichnis /src aus adressierbar ist, wo die Quelldateien gespeichert sind. Beide Strukturen sind gleichermaßen gut geeignet. Für die folgenden Beispiele wird die erste Verzeichnisstruktur verwendet.