JDeveloper 11g: Automatisches Erzeugung von von Javadoc-Tags

JDeveloper Version: 11.1.1.2.0

Einleitung

Mit JDeveloper 11g ist es sehr leicht möglich, fehlende Javadoc-Tags automatisch erzeugen zu lassen. Das ist eine große Hilfe für alle, die, so wie ich, die Javadoc-Tags bei der Entwicklung nur zu gerne vergessen.

Eigenschaften der Javadoc-Tags festlegen

Dies geschieht im Menüpunkt Tools –> Preferences unter dem Punkt Code Editor –> Java –> Javadoc. Wenn zum Beispiel festgelegt werden soll, dass in jedem Javadoc-Kommentar zu einer Klasse der Tag @author mit dem Namen des Entwicklers erscheinen soll, so muss folgendes eingegeben werden:

Erzeugen eines neuen Audit-Profiles

Unter Tools –> Preferences muss im Punkt Audit –> Profiles ein Profil erstellt werden, welches unter anderem das Vorhandensein der als Required gekennzeichneten Javadoc-Tags prüft. Dafür wird zuerst das Profil Javadoc Rules gewählt und mit Save As eine Kopie davon unter einem neuen Namen gespeichert. In dem neuen Profil werden dann alle Regeln deaktiviert bis auf Javadoc Comments:

Generieren der Javadoc-Tags

Das Erzeugen der Tags erfolgt über die Code-Audit-Funktion des JDeveloper. Die Funktion kann angewendet werden auf komplette Projekte, Packages oder beliebige Java-Klassen. In diesem Beispiel wird sie auf ein komplettes Projekt angewendet.

Dazu wird das Projekt im Navigator ausgewählt und dann der Punkt Build –> Audit gewählt.

Im Log werden anschließend die gefundenen Probleme angezeigt:

Nun werden alle fehlenden Javadoc-Tags ganz einfach erzeugt, indem das Projekt markiert und anschließend Rechte Maustaste –> Apply Default Fixes gewählt wird.

Die automatisch erzeugten Javadoc-Tags sehen dann so aus:

Ergänzen von fehlenden Punkten nach dem ersten Satz

Die Javadoc-Spezifikation schreibt vor, dass der erste Satz eines Kommentares zu einer Klasse, Methode usw. mit einem Punkt beendet wird. Auch dies kann, nachdem die Kommentare erfasst wurden, mit dem neuen Profil geprüft und fehlende Punkte automatisch ergänzt werden.

Fazit

Auch wenn das automatische Generieren der Javadoc-Tags im JDeveloper ein wenig versteckt und nicht direkt aus dem Menü heraus erreichbar ist, so ist es doch sehr hilfreich und entlastet den Entwickler während der eigentlichen Programmierung ungemein.