link - javadoc private




Wie dokumentiere ich Pakete in Java? (2)

In den Java-APIs kann ich Javadoc-Kommentare für Pakete sehen.

Wie / wo platziere ich Javadoc-Kommentare, um ein Paket zu dokumentieren?


Bis Java 1.4 mussten Sie eine HTML-Datei package.html bereitstellen, wie in den anderen Antworten beschrieben.

Seit Java 1.5 können Sie auch ein package-info.java , das einen regulären Javadoc-Kommentar (kein HTML) enthält. Letzteres wird bevorzugt, da es einige zusätzliche Funktionen (insbesondere Paketanmerkungen) bietet.

Details: Suns Dokumente für Javadoc


Mit einer package.html Datei auf der package.html (dh im Verzeichnis für dieses Paket). Dies sollte eine vollständig formatierte HTML Datei sein, in der das <html> -Tag definiert ist





javadoc