So generieren Sie Javadoc über die Befehlszeile

Lesezeit: 4 Minuten

Benutzer-Avatar
Damir

Kann mir jemand zeigen, wie man Javadoc über die Befehlszeile generiert?

Mein Projekt enthält das Paket com.test und ich möchte die generierte Dokumentation in Dateien ablegen, die sich in einem bestimmten Ordner wie diesem befinden: C:/javadoc/test.

Benutzer-Avatar
Arun P. Johny

Sie können die beziehen javadoc 8-Dokumentation

Ich denke, was Sie sehen, ist ungefähr so:

javadoc -d C:\javadoc\test com.test

  • Es fügt automatisch ein zusätzliches ‘/’ nach dem Paketnamen für mich hinzu, wie wenn Paket ist: com.test und drinnen gibt es dann die Main-Klasse, die als Ausgabe ausgegeben werden sollte com/test/Main.html aber es wird versuchen, in die Datei zu schreiben com/test//Main.html seltsam!

    – Harschiw

    13. April 2017 um 18:21 Uhr

  • Juhu, das hat auch unter Linux funktioniert. javadoc -d path/to/output/folder myClass.java

    – Koch Pharao

    30. Januar 2019 um 15:17 Uhr

Benutzer-Avatar
infogizmo

Oracle bietet einige einfache Beispiele:

http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJBGFC

Angenommen, Sie befinden sich in ~/ und der Java-Quellbaum befindet sich in ./saxon_source/net und Sie möchten den gesamten Quellbaum rekursiv durchlaufen. net ist sowohl ein Verzeichnis als auch der Name des obersten Pakets.

mkdir saxon_docs
javadoc -d saxon_docs -sourcepath saxon_source -subpackages net

  • -subpackages war die wichtigste Information, nach der ich gesucht habe. Vielen Dank!

    – der_neue_mr

    25. April um 8:22 Uhr

Benutzer-Avatar
Shimizu

Angenommen, Sie haben die folgende Verzeichnisstruktur, in der Sie Javadocs generieren möchten file1.java und file2.java (Paket com.test), wobei die Javadocs eingefügt werden C:\javadoc\test:

C:\
|
+--javadoc\
|  |
|  +--test\
|
+--projects\
   |
   +--com\
      |
      +--test\
         |
         +--file1.java
         +--file2.java

Navigieren Sie im Befehlsterminal zum Stammverzeichnis Ihres Pakets: C:\projects. Wenn Sie nur die Standard-Javadocs für alle Java-Dateien im Projekt generieren möchten, führen Sie den folgenden Befehl aus (bei mehreren Paketen trennen Sie die Paketnamen durch Leerzeichen):

C:\projects> javadoc -d [path to javadoc destination directory] [package name]

C:\projects> javadoc -d C:\javadoc\test com.test

Wenn Sie javadocs von woanders ausführen möchten, müssen Sie den Quellpfad angeben. Wenn Sie beispielsweise javadocs in in ausführen würden C:\würden Sie den Befehl wie folgt ändern:

C:\> javadoc -d [path to javadoc destination directory] -sourcepath [path to package directory] [package name]

C:\> javadoc -d C:\javadoc\test -sourcepath C:\projects com.test

Wenn Sie javadocs nur für ausgewählte .java-Dateien ausführen möchten, fügen Sie die Quelldateinamen durch Leerzeichen getrennt hinzu (Sie können ein Sternchen verwenden

C:\> javadoc -d [path to javadoc destination directory] [source filenames]

C:\> javadoc -d C:\javadoc\test C:\projects\com\test\file1.java

für einen Platzhalter). Stellen Sie sicher, dass Sie den Pfad zu den Dateien angeben: Weitere Informationen/Szenarien finden Sie hierhier

  • .

    Machen Sie einfach so etwas wie C:\> javadoc -d C:\javadoc\test C:\projects\com\test\*.java JavaDoc ist sonst so frustrierend (zumindest unter Windows).

    – Salvador Valencia


  • 21. September 2016 um 19:38 Uhr

    der Link ist tot

    – Peer

15. November 2019 um 21:11 Uhr
Benutzer-Avatar

Rakesh Soni

  • Wenn ich zum Beispiel eine Anwendungsquellcodestruktur hätte, die so aussähe:
  • C:\b2b\com\steve\util\
  • C:\b2b\com\steve\app\

C:\b2b\com\steve\gui\

javadoc -d "C:\docs" -sourcepath "C:\b2b" -subpackages com

Dann würde ich machen:

Und das sollte Javadocs für den Quellcode des com-Pakets und aller Unterpakete (rekursiv) erstellen, die sich im Verzeichnis “C:\b2b” befinden. javadoc *.java

Gehen Sie einfach in den Ordner, in dem Ihr gesamter Java-Code gespeichert ist, sagen Sie E:/javaFolder und dann

E:\javaFolder> javadoc *.java

Beispiel Die gegebenen Antworten waren nicht ganz vollständig, wenn mehrere Quellpfad

und Unterpakete verarbeitet werden müssen. Die folgende Befehlszeile verarbeitet alle Pakete unter com und LOR (Herr der Ringe) befindet sich in /home/rudy/IdeaProjects/demo/src/main/java und

/home/rudy/IdeaProjects/demo/src/test/java/

  • Bitte beachten Sie:
  • es ist Linux und die Pfade und Pakete sind durch ‘:’ getrennt

[email protected]:~$ javadoc -d /home/rudy/IdeaProjects/demo_doc
-sourcepath /home/rudy/IdeaProjects/demo/src/main/java/
:/home/rudy/IdeaProjects/demo/src/test/java/
-subpackages com:LOR 
-private

[email protected]:~/IdeaProjects/demo/src/main/java$ ls -R 
.: com LOR
./com: example
./com/example: demo
./com/example/demo: DemowApplication.java
./LOR: Race.java TolkienCharacter.java

[email protected]:~/IdeaProjects/demo/src/test/java$ ls -R 
.: com
./com: example
./com/example: demo
./com/example/demo: AssertJTest.java DemowApplicationTests.java

die ich privat verwendet habe und wollte, dass alle Klassen und Mitglieder dokumentiert werden
Benutzer-Avatar

Simpal Kumar

Link zu JavaDoc

javadoc -d C:/javadoc/test com.mypackage

1158840cookie-checkSo generieren Sie Javadoc über die Befehlszeile

This website is using cookies to improve the user-friendliness. You agree by using the website further.

Privacy policy