Come generare file HTML Javadoc in Eclipse?

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

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

Come posso generare file HTML Javadoc utilizzando l’IDE Eclipse?

  1. Progetto > Genera Javadoc ....

  2. Nel comando Javadoc: field, cerca javadoc.exe (di solito in [path_to_jdk_directory] \ bin \ javadoc.exe ).

  3. Seleziona la casella accanto al progetto / pacchetto / file per il quale stai creando Javadoc.

  4. Nel campo Destinazione: cerca per trovare la destinazione desiderata (ad esempio, la directory principale del progetto corrente).

  5. Fai clic su Fine .

Ora dovresti riuscire a trovare il Javadoc appena generato nella cartella di destinazione. Apri index.html .

Come generare Javadoc in Eclipse?

  1. Apri la cartella del progetto Eclipse.

  2. Seleziona Progetto > Genera Javadoc ....

  1. Al primo passaggio della procedura guidata, è ansible definire le impostazioni per:

    3.1. Selezionare il percorso per lo strumento javadoc.exe da JDK.
    3.2. Risorse di progetto per le quali generare Javadoc.
    3.3. Classi e metodi per i quali generare Javadoc in base alla loro visibilità.
    3.4. Posizione di Javadoc (per impostazione predefinita verrà posizionata nella cartella doc nella posizione del progetto).

  1. Al secondo passaggio puoi configurare le impostazioni relative a:

    4.1. Titolo del documento.
    4.2. Struttura della documentazione
    4.3. Seleziona i tag del documento da elaborare.
    4.4. Altre risorse (archivi, progetti) utilizzate nel progetto devono essere incluse nella documentazione.
    4.5. Seleziona il foglio di stile CSS per la tua documentazione.

  1. All’ultimo passaggio è ansible salvare le impostazioni in uno script Ant per uso futuro.

Questa è una risposta integrativa relativa all’OP:

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

  1. Vai su Aiuto > Eclipse Marketplace ....
  2. Trova “JAutodoc”.
  3. Installalo e riavvia Eclipse.

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

Puoi anche farlo dalla riga di comando molto facilmente.

  1. Aprire la riga di comando dalla cartella / pacchetto.
  2. Dalla riga di comando eseguire:

    javadoc YourClassName.java

  3. Per generare in batch documenti per più classi:

    javadoc * .java

Per aggiungere rapidamente un Javadoc usa la seguente scorciatoia:

Windows : alt + maiusc + 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 scelta rapida.