Javadoc-Überprüfung mit DocLint

Neu in Java 8 ist eine Erweiterung des Javadoc Tools, die in den Javadoc-Kommentaren Fehler aufspürt. Es heißt DocLint. Aktiviert wird diese Prüfung mit dem Schalter –Xdoclint und es erkennt folgende Gruppen von Fehlern, die auch als Option angegeben werden können:

Gruppe

Beschreibung

accessibility

Prüft auf Probleme mit der Zugänglichkeit der Dokumentation, dass etwa Tabellen immer eine Zusammenfassung besitzen.

html

Erkennt HTML-Fehler, wie fehlende schließende spitze Klammern.

missing

Prüft auf fehlende Elemente, wenn zum Beispiel ein Kommentar fehlt, oder @return.

reference

Prüft alle Referenzen in den Javadoc-Tags, etwa bei @see oder auch ungültige Namen bei @param.

syntax

Prüft allgemeine Syntaxfehler wie nicht ausmaskierte HTML-Zeichen wie “<“, „>“ oder „&“ und nicht existierende Javadoc-Tags

Mögliche Gruppen bei Javadoc und dem DocLint Werkzeug

Zu weitere Optionen der Javadoc-Erweiterung siehe http://download.java.net/jdk8/docs/technotes/tools/windows/javadoc.html.

Ähnliche Beiträge

2 Gedanken zu “Javadoc-Überprüfung mit DocLint

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert