Wie generiere ich Javadoc HTML-Dateien in Eclipse?

165

Ich habe solche Kommentare im Javadoc-Stil in den Code meines Projekts geschrieben:

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

Wie kann ich Javadoc-HTML-Dateien mit der Eclipse-IDE generieren?

java eclipse javadoc JaneNY
quelle
verweisen Sie dies. learnjava-soa.blogspot.com/2015/06/…
madhu

Antworten:

234

  1. Project> Generate Javadoc....

  2. Javadoc command:Suchen Sie im Feld nach javadoc.exe (normalerweise unter [path_to_jdk_directory] \ bin \ javadoc.exe ).

  3. Aktivieren Sie das Kontrollkästchen neben dem Projekt / Paket / der Datei, für die Sie das Javadoc erstellen.

  4. Destination:Suchen Sie im Feld nach dem gewünschten Ziel (z. B. dem Stammverzeichnis des aktuellen Projekts).

  5. Klicken Sie auf Finish.

Sie sollten nun in der Lage sein, das neu generierte Javadoc im Zielordner zu finden. Öffnen Sie index.html .

Renu P.
quelle
1
Muss das Java JDK installiert werden? Ich habe Java installiert und kann Java-Programme in Eclipse erstellen ... aber javadoc.exees ist nirgendwo auf meinem Laufwerk vorhanden!
AlainD
Alt, aber für alle, die in Zukunft verwirrt sein könnten, prüfen Sie, ob Sie das JDK im Gegensatz zur JRE installiert haben (die an dieser Stelle keine javadoc.exe enthält).
Omoshiroiii
9

Dies ist eine ergänzende Antwort im Zusammenhang mit dem OP:

Eine einfache und zuverlässige Lösung zum Hinzufügen von Javadocs-Kommentaren in Eclipse:

  1. Gehe zu Help> Eclipse Marketplace....
  2. Finde "JAutodoc".
  3. Installieren Sie es und starten Sie Eclipse neu.

Um dieses Tool zu verwenden, klicken Sie mit der rechten Maustaste auf Klasse und klicken Sie auf JAutodoc.

PionierBhawna
quelle
7
AFAIK, JAutodoc generiert kein HTML aus vorhandenen Javadoc-Kommentaren (was in der Frage gefordert wird), sondern hilft beim Generieren der Javadoc-Kommentare.
Amani Kilumanga
3
Die Antwort hat nichts mit der Frage zu
tun
Mit Eclipse können Sie Javadocs generieren: Projekt -> Javadocs generieren ...
Pongapundit
Dadurch wird nur Javadoc generiert, nicht das HTML, um das es bei dieser Frage geht.
Ashish
5

Sie können dies auch sehr einfach über die Befehlszeile tun.

  1. Öffnen Sie die Befehlszeile aus dem Ordner / Paket.

  2. Über die Befehlszeile ausführen:

    javadoc YourClassName.java

  3. So generieren Sie Dokumente im Stapel für mehrere Klassen:

    javadoc * .java

Sean Das
quelle
2

Verwenden Sie die folgende Verknüpfung, um schnell ein Javadoc hinzuzufügen:

Windows : alt+ shift+J

Mac : ⌘+ Alt+J

Abhängig vom ausgewählten Kontext wird ein Javadoc gedruckt. Um von OP geschriebenes Javadoc zu erstellen, wählen Sie die entsprechende Methode aus und drücken Sie die Shotcut-Tasten.

Jacob van Lingen
quelle