Schneller und effizienter entwickeln – mit Javadoc

Ein weiteres Beispiel für eine Stelle im Quellcode, an der man vielleicht gerne einen Link zur externen Dokumentation anbringen möchte, ist die Design-Dokumentation auf höherer Ebene wie Use-Case- oder Ablaufdiagramme. Ablaufdiagramme sind sehr anschaulich, wenn man die Kommunikation, die Interaktion oder die Schnittstellen des Systems mit anderen Systemen oder seinen Komponenten spezifizieren will. Leider kann man aus einem Ablaufdiagramm nicht automatisch Code erzeugen, und auch das Re-Engineering aus Quellcode zurück in ein Ablaufdiagramm funktioniert nicht. Daher muss man sowohl Diagramm als auch Quellcode parallel pflegen. Dies ist einfacher, wenn man ein Ablaufdiagramm – zum Beispiel eine Nachrichtenübermittlung zwischen zwei Akteuren – von demjenigen Code-Anschnitt aus verlinkt, welcher dieses Diagramm umsetzt.

Wenn das Ablaufdiagramm aus einem einfachen ASCII-Diagramm besteht, könnte man einen Link wie in Abbildung A erstellen.

Abbildung A

Anschließend würde man mithilfe der Zuordnungsdatei spec.html hierauf verweisen. Der solcherart organisierte Dokumentationsprozess ist vergleichsweise einfach und flexibel. Hierzu braucht man nur einen Texteditor, das Javadoc-Tool und eventuell ein Versionskontrollsystem. Auf raffinierte (und teure) CASE-Tools kann man dann getrost verzichten.