In den Java-APIs kann ich Javadoc-Kommentare für Pakete sehen.
Wie/wo platziere ich Javadoc-Kommentare, um ein Paket zu dokumentieren?
Wie dokumentiere ich Pakete in Java?
Lesezeit: 2 Minuten
13535500cookie-checkWie dokumentiere ich Pakete in Java?
Gareth Davis
Ab 1.5 können Sie a definieren package-info.java Datei und geben Sie einen Standardkommentar im Javadoc-Stil für ein Paket ein:
com/foo/package-info.java:
/**
* com.foo is a group of bar utils for operating on foo things.
*/
package com.foo;
//rest of the file is empty
-
Direktlink zur Spezifikation: docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1
– Givenkoa
5. Oktober 2012 um 11:57 Uhr
-
In intellij können Sie mit der rechten Maustaste auf ein Paket klicken und die Option zum Erstellen dieses Pakets sollte sich im Menü „Neue Datei“ befinden
– Basautner
30. April 2014 um 17:45 Uhr
-
Ich fand die benötigte Datei in Paketname/src/Paketname (mit den restlichen Quelldateien)
– trindflo
24. April 2019 um 19:07 Uhr
schleske
Bis einschließlich 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 eine bereitstellen package-info.java, die einen regulären Javadoc-Kommentar (kein HTML) enthält. Letzteres wird bevorzugt, da es Ihnen einige zusätzliche Funktionen bietet (insbesondere Paketanmerkungen).
Einzelheiten:
Suns Dokumente für javadoc
-
+1 für die Erwähnung beider Wege und den wesentlichen Unterschied zwischen ihnen. Übrigens hat zumindest IntelliJ IDEA derzeit eine bessere Unterstützung für package.html (Strg-Q auf einem Paketnamen zeigt das Paket Javadocs).
– Jonik
23. März 2009 um 19:29 Uhr
-
Update zu meinem vorherigen Kommentar: Heutzutage unterstützt IDEA
package-info.javaAlles gut.– Jonik
28. Mai 2013 um 19:38 Uhr
Mit einer package.html Datei auf Paketebene (dh im Verzeichnis für dieses Paket). Dies sollte eine vollständig ausgebildete sein HTML Datei, mit der <html> Tag darin definiert
-
Mehr Details? Wie soll die Datei aussehen?
– jjnguy
8. März 2009 um 22:23 Uhr
-
Es ist eine HTML-Datei, die die Beschreibung Ihres Pakets enthält. Das ist es!
– oxbow_lakes
8. März 2009 um 22:25 Uhr
-
Dies ist die alte Art, es zu tun. Ab Java 1.5 können Sie package-info.java verwenden
– k2col
1. November 2013 um 16:20 Uhr
