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
Weitere schwerwiegende Fehler stecken in Android 12 und 13. Insgesamt bringt der Mai-Patchday 29 Fixes.
IT-Sicherheit - Erkennen und Abwehren von digitalen Angriffen
Das iPhone 15 Pro Max ist das meistverkaufte Smartphone im ersten Quartal. Das Galaxy S24…
Die Passwort-Alternative Passkeys überholt Einmalpasswörter bei der Zwei-Faktor-Authentifizierung. Auch Microsoft setzt sich aktiv für die…
Der Anteil steigt seit 2020 um 34 Prozentpunkte. Allein 2023 erfasst Kaspersky rund 10 Millionen…
Salesforce forciert den Ausbau seiner Industry Clouds. Mit ihrem Prozesswissen könnten deutsche IT-Dienstleister davon profitieren.