So erstellt man Doclets für Javadoc

Vielen Entwicklern war bislang sicher nicht bewusst, dass Javadoc als eigenes Dokumentations-Tool verwendet werden kann. Das heißt: Für sämtliche Aufgaben lässt sich eine eigene Klasse oder ein eigenes Doclet erstellen, in dem der Quellcode als Input benutzt wird.

Wer ein Doclet erstellen will, muss zuerst einmal eine Klasse erzeugen, die folgende Methode implementiert:


public static boolean start(RootDoc root)

Es müssen weder Schnittstellen implementiert noch bestimmte Klassen erweitert werden. Wer mag, kann jedoch die vordefinierte Klasse com.sun.javadoc.Doclet erweitern.

Bei der Ausführung wird dem Javadoc-Tool mitgeteilt, dass die Klasse die Quelldokumente unter Verwendung des Parameters -doclet verarbeiten soll. Ein typischer Befehl sieht beispielsweise so aus:


>javadoc -docletpath bin -doclet tips.DocletTip src/tips/*.java

Dabei gilt es zu beachten, dass beim Kompilieren der Doclet-Klasse die Datei tools.jar im Klassenpfad enthalten sein muss. Die Datei tools.jar befindet sich im Verzeichnis JAVA_HOME/lib.

Der Startmethode der Doclet-Klasse wird eine Instanz von com.sun.javadoc.RootDoc übergeben. RootDoc ermöglicht den Zugriff auf alle Klassen sowie auf alle Methoden und Felder der Klassen. Für jedes dieser Objekte können sämtliche ihm zugewiesene Javadoc-Objekte abgefragt werden.

Page: 1 2

ZDNet.de Redaktion

Recent Posts

Black Friday: Vorsicht vor schädlichen QR-Codes

Bösartige QR-Codes, die per E-Mail versendet werden, eignen sich sehr gut, um Spam-Filter zu umgehen.

7 Stunden ago

Black Friday: Zahl der ominösen Shopping-Websites steigt

Unsichere Websites und Phishing-Mails in Verbindung mit Black Friday können kauffreudigen Konsumenten zum Verhängnis werden.

7 Stunden ago

SmokeBuster bekämpft SmokeLoader

Malware SmokeLoader wird weiterhin von Bedrohungsakteuren genutzt, um Payloads über neue C2-Infrastrukturen zu verbreiten.

14 Stunden ago

Taugen Kryptowährungen als Unterstützer der Energiewende?

Bankhaus Metzler und Telekom-Tochter MMS testen, inwieweit Bitcoin-Miner das deutsche Stromnetz stabilisieren könnten.

1 Tag ago

Supercomputer-Ranking: El Capitan überholt Frontier und Aurora

Mit 1,7 Exaflops ist El Capitan nun der dritte Exascale-Supercomputer weltweit. Deutschland stellt erneut den…

1 Tag ago

Ionos führt neue AMD-Prozessoren ein

Der deutsche Hyperscaler erweitert sein Server-Portfolio um vier Angebote mit den neuen AMD EPYC 4004…

1 Tag ago