Questa procedura guidata consente di generare la generazione Javadoc. Si tratta di un'interfaccia utente per lo strumento javadoc.exe disponibile nel JDK Java. Per una documentazione completa sugli strumenti Javadoc, visitare la pagina Sun's Javadoc Tool.
Per eseguire questa procedura guidata, č necessario configurare un comando Javadoc nella pagina delle preferenze Javadoc (Finestra> Preferenze > Java > Javadoc).
Selezione tipi:
Opzione |
Descrizione |
---|---|
Seleziona i tipi per cui verrā generato Javadoc |
Nell'elenco, selezionare o deselezionare le caselle per specificare esattamente i tipi che si desidera esportare nel file JAR. Questo elenco č inizializzato dalla selezione del workbench. Č possibile selezionare un solo progetto per volta in quanto, durante l'esecuzione dello strumento Javadoc, č possibile utilizzare un solo percorso classi di progetto per volta. |
Crea Javadoc per i membri con visibilitā |
|
Utilizza doclet standard |
Avviare il comando Javadoc con il doclet standard (predefinito)
|
Utilizza doclet personalizzato |
Utilizzare un doclet personalizzato per produrre la documentazione
|
Argomenti doclet standard (disponibile quando č selezionato Utilizza doclet standard):
Opzione |
Descrizione |
---|---|
Titolo documento |
Specificare un titolo di documento. |
Genera pagina d'uso | Selezionare questa opzione se si desidera che la documentazione contenga una pagina d'uso. |
Genera struttura della gerarchia | Selezionare questa opzione se si desidera che la documentazione contenga una pagina di struttura. |
Genera barra di navigazione |
Selezionare questa opzione se si desidera che la documentazione contenga una barra di navigazione (intestazione e pič di pagina). |
Genera indice | Selezionare questa opzione se si desidera che la documentazione contenga una pagina di indice. |
Genera indice per lettera | Crea un indice per lettera. Questa opzione č attiva quando č selezionato Genera indice. |
@author | Selezionare questa opzione se si desidera che venga documentato il tag @author. |
@version | Selezionare questa opzione se si desidera che venga documentato il tag @version. |
@deprecated | Selezionare questa opzione se si desidera che venga documentato il tag @deprecated. |
elenco non consigliato | Selezionare questa opzione se si desidera che la documentazione contenga una pagina di elementi non consigliati. Questa opzione č attiva quando č selezionata l'opzione @deprecated. |
Seleziona classi con riferimenti per cui Javadoc deve creare collegamenti |
Specificare la documentazione a cui Javadoc deve creare collegamenti quando si fa riferimento ad altri tipi.
|
Foglio di stile | Selezionare il foglio di stile da utilizzare |
Opzioni Javadoc generali:
Opzione |
Descrizione |
---|---|
Panoramica |
Specifica che Javadoc deve richiamare il testo per la documentazione panoramica dal file dato. Tale testo verrā inserito nel file overview-summary.html. |
Opzioni non Javadoc |
Aggiungere opzioni extra qui: opzioni doclet personalizzate, opzioni VM oppure opzioni di compatibilitā JRE 1.4. |
Salva le impostazioni di questa esportazione Javadoc come script Ant |
Specificare che si desidera memorizzare uno script Ant che eseguirā l'esportazione Javadoc specificata senza che sia necessario utilizzare la procedura guidata. Questa procedura guidata consente di modificare lo script Ant esistente (utilizzare Apri procedura guidata Javadoc dal menu di scelta rapida dello script Ant generato) |
Apri file di indice generato nel browser | Apre il file index.html generato nel browser (disponibile solo quando si utilizza il doclet standard) |
Premere Fine per avviare la generazione Javadoc. Se la destinazione č diversa rispetto al percorso configurato nella pagina del percorso Javadoc del progetto, verrā richiesto se si desidera impostare il percorso Javadoc del progetto nella nuova cartella di destinazione. In questo modo, tutti i richiami di Apri Javadoc esterno utilizzeranno la documentazione appena creata.
Verrā avviato un nuovo processo e verrā eseguita la generazione in background. Aprire la vista Console (Finestra > Mostra vista > Console) per vedere lo stato di avanzamento della generazione.
Creazione della documentazione Javadoc
Azioni del menu File
Preferenze Javadoc
Proprietā del percorso Javadoc