~Java4Beginners~
~Java4Beginners~

JavaDoc

Javadoc ist ein Software-Dokumentationswerkzeug, das aus Java-Quelltexten automatisch HTML-Dokumentationsdateien erstellt.

JavaDoc mit NetBeans generieren

Unter NetBeans ist es einfach, sich ein JavaDoc von seinem Projekt erstellen zu lassen.
Rufen Sie hierfür als erstes das Kontextmenü Ihres Projektes auf und wählen Sie den Menüpunkt generate Javadoc.

In der Ausgabeconsole von NetBeans können Sie nun die einzelnen Klassen ersehen, welche in das JavaDoc integriert werden.

In Ihrem Projektordner finden Sie nun unter dem Pfad /dist/javadoc eine Index.html. Dieses ist die Startdatei Ihrer Dokumentation.

In diesem JavaDoc können Sie nun verschiedene Angaben ablesen.
  1. implemenitierte Interface-Klassen von der Java-Bibilothek
  2. Klassenheader
  3. eingebetette und abgeleitete Klassen und Methoden
  4. Implementierte Methoden der Klasse
Der Vorteil des JavaDocs ist es, dass alle Mitarbeiter des Projektes immer einen Überblick über die vorhandenen Schnittstellen haben.
Knausern Sie nicht mit Javadoc-Kommentaren. Je ausführlicher diese Kommentare sind, desto selbsterklärender ist Ihre Projektdokumentation an Hand der generierten Javadoc-HTML-Datei.
nach oben Java4Beginners -- Seitenversion 1.0 -- Stand: 2017-04-25