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

Microsoft verschiebt erneut Copilot Recall

Die Entwickler arbeiten noch an weiteren „Verfeinerungen“. Windows Insider erhalten nun wohl eine erste Vorschau…

13 Stunden ago

GenKI im Job: Mitarbeitende schaffen Tatsachen

Laut Bitkom-Umfrage werden in jedem dritten Unternehmen in Deutschland private KI-Zugänge genutzt. Tendenz steigend.

15 Stunden ago

97 Prozent der Großunternehmen melden Cyber-Vorfälle

2023 erlitten neun von zehn Unternehmen in der DACH-Region Umsatzverluste und Kurseinbrüche in Folge von…

15 Stunden ago

„Pacific Rim“-Report: riesiges, gegnerisches Angriffs-Ökosystem

Der Report „Pacific Rim“ von Sophos beschreibt Katz-und-Maus-Spiel aus Angriffs- und Verteidigungsoperationen mit staatlich unterstützten…

19 Stunden ago

DeepL setzt erstmals auf NVIDIA DGX SuperPOD mit DGX GB200-Systemen

NVIDIA DGX SuperPOD soll voraussichtlich Mitte 2025 in Betrieb genommen und für Forschungsberechnungen genutzt werden.

19 Stunden ago

Latrodectus: Gefährlicher Nachfolger von IcedID

Latrodectus, auch bekannt als BlackWidow, ist auch unter dem Namen LUNAR SPIDER bekannt.

19 Stunden ago