JAutodoc: Javadoc automatisch generieren

Der Kommentator


Besonders im universitären Bereich ist es geradezu eine Pest: Jedes noch so kleine Beispiel muss aufwändig mit Javadoc-Kommentaren versehen werden. Ob diese Kommentare sinnvoll sind, ist irrelevant. Das ruft nach Automatisierung.

Wer mit Eclipse entwickelt, sollte sich JAutodoc als kleines Helferlein anlachen. Das Plug-in [1] erstellt die Dokumentation automatisch – und arbeitet dabei so genau, dass man auf den ersten Blick meint, die Javadoc-Kommentare wären von Hand erstellt. Zur effizienteren Installation bietet der Entwickler auch einen Updateserver an, der Eclipse das direkte Installieren aus dem GUI heraus (also ohne manuelles Herumkopieren) erlaubt. Dazu wählt man Help | Install New Software und gibt ins Feld Work With den String http://jautodoc.sourceforge.net/update/ ein. Nach einem Druck auf Enter wird JAutodoc zum Download angeboten und lässt sich nach Abnicken der Sicherheitswarnung automatisch installieren.

Wie geht das?

Nach dem obligatorischen Neustart der Entwicklungsumgebung ist das Plug-in einsatzbereit. Die einfachste Art des Einsatzes besteht darin, ein Projekt im Package Explorer rechts anzuklicken und im daraufhin erscheinenden Kontextmenü die Option JAutodoc | Add Javadoc zu wählen. JAutodoc macht sich dann sofort an die Arbeit und versieht alle möglichen Stellen mit Kommentaren im Javadoc-Stil. Dabei agiert das Produkt teilweise überraschend intelligent. Zum Beispiel erkennt es init-Methoden anhand des Namens und versieht sie – wie im Beispiel gezeigt – selbsttätig mit einem passenden Kommentar:

/**  * Inits the rapper.  */ private void initRapper()

Die Namen normaler Methoden entstehen durch die Trennung der einzelnen „Wörter“ des Methodennamens. Das Verwenden von Camel Case hilft dem Plug-in bei der Identifizierung der Trennstellen. Übrigens werden auch Member-Variablen nach dem Schema „Namen splitten“ bearbeitet:

/**  * Big boom.  */ public void bigBoom()

Singleton-bezogene Funktionen erkennt das Programm ebenfalls selbsttätig – das Beispiel unten stammt wie die zuvor gezeigten Codesegmente aus einer JezzBall-Portierung für die BlackBerry-Plattform, die aus diversen Gründen niemals ausgeliefert wurde:

/**  * Gets the single instance of BallZNoiseMaker.  *  * @return single instance of BallZNoiseMaker  */ static public BallZNoiseMaker getInstance()

Mit Maß und Ziel

Obwohl das automatische Dokumentieren ganzer Projekte zweifellos reizvoll ist, erscheint dieses Feature in manchen Situationen als totaler Overkill. JAutodoc er...

Neugierig geworden?

Angebote für Teams

Für Firmen haben wir individuelle Teamlizenzen. Wir erstellen Ihnen gerne ein passendes Angebot.

Das Library-Modell:
IP-Zugang

Das Company-Modell:
Domain-Zugang