Come generare file HTML Javadoc in Eclipse?

165

Ho scritto commenti in stile Javadoc come questo nel codice del mio progetto:

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

Come posso generare file HTML Javadoc usando l'IDE Eclipse?

java eclipse javadoc

— JaneNY
fonte

riferiscilo. learnjava-soa.blogspot.com/2015/06/…

— madhu l'

234

Project> Generate Javadoc....
Nel Javadoc command:campo, cercare javadoc.exe (in genere in [path_to_jdk_directory] \ bin \ javadoc.exe ).
Seleziona la casella accanto al progetto / pacchetto / file per cui stai creando Javadoc.
Nel Destination:campo, cercare la destinazione desiderata (ad esempio, la directory principale del progetto corrente).
Fare clic Finish.

Ora dovresti essere in grado di trovare il Javadoc appena generato nella cartella di destinazione. Apri index.html .

— Renu P
fonte

1

Java JDK deve essere installato? Ho Java installato e posso creare programmi Java in Eclipse ... ma javadoc.exenon esiste da nessuna parte sul mio disco!

— AlainD,

Vecchio, ma per chiunque in futuro possa essere confuso su questo, controlla se hai JDK installato al contrario di JRE (che non contiene javadoc.exe in questa posizione).

— omoshiroiii,

9

Questa è una risposta supplementare relativa al PO:

Una soluzione semplice e affidabile per aggiungere commenti Javadocs in Eclipse:

Vai a Help> Eclipse Marketplace....
Trova "JAutodoc".
Installalo e riavvia Eclipse.

Per utilizzare questo strumento, fare clic con il tasto destro sulla classe e fare clic su JAutodoc.

— pioneerBhawna
fonte

7

AFAIK, JAutodoc non genera HTML dai commenti javadoc esistenti (che è ciò che la domanda chiede), ma aiuta piuttosto a generare i commenti javadoc.

— Amani Kilumanga,

3

La risposta non è correlata alla domanda, ma questo è esattamente quello che stavo cercando :)

— keya

Eclipse ti permetterà di generare Javadocs: Progetto -> Genera Javadocs ...

— pongapundit

Questo genererà solo javadoc, non l'html di cui si tratta.

— Ashish,

5

Puoi anche farlo dalla riga di comando molto facilmente.

Apri la riga di comando dalla cartella / pacchetto.
Dall'esecuzione dalla riga di comando:

javadoc YourClassName.java
Per generare in batch documenti per più classi:

javadoc * .java

— Sean Das
fonte

2

Per aggiungere rapidamente un Javadoc utilizzare la seguente scorciatoia:

Windows : alt+ shift+J

Mac : ⌘+ Alt+J

A seconda del contesto selezionato, verrà stampato un Javadoc. Per creare Javadoc scritto da OP, selezionare il metodo corrispondente e premere i tasti di taglio.

— Jacob van Lingen
fonte