Javadoc

Ci sto lavorando

Oggetto: Come istallare ed utilizzare Javadoc

Contenuti:
1		FaqJavaDoc - Istallazione
2		How to Write Doc Comments for the Javadoc Tool
3		Java SE Development Kit 8u161 Documentation
4

Esempi:
1
2
3
4

Per generare la documentazione Javadoc utilizzando NetBeans, segui questi passaggi:

1. Aggiungi Commenti Javadoc:

   • Assicurati di aver inserito commenti Javadoc nei tuoi sorgenti Java. Questi commenti dovrebbero essere posti subito prima della dichiarazione di una classe, interfaccia, metodo o attributo.
   • I commenti Javadoc dovrebbero descrivere in modo sintetico lo scopo dell’oggetto che stai documentando.

2. Genera Javadoc:

   • Fai clic con il tasto destro del mouse sul tuo progetto nella finestra Project.
   • Seleziona Tools > Analyze Javadoc.
   • Questo genererà la documentazione Javadoc per tutte le classi nel tuo progetto.

3. Visualizza la Documentazione:

   • Dopo aver eseguito l’analisi Javadoc, troverai i file HTML generati nella directory dist del tuo progetto.
   • Apri questi file HTML nel tuo browser per visualizzare la documentazione Javadoc.

In alternativa, puoi anche generare Javadoc per un singolo file o un pacchetto specifico:

1. Genera Javadoc per un Singolo File:

   • Posiziona il cursore all’interno della dichiarazione di una classe o di un metodo.
   • Premi Alt + Enter e seleziona “Create Javadoc”.

2. Genera Javadoc per un Pacchetto:

   • Fai clic con il tasto destro del mouse sul pacchetto desiderato nella finestra Project.
   • Seleziona Tools > Analyze Javadoc.
   • L’Analyzer mostrerà quali Javadoc mancano e ti permetterà di crearli per i metodi specifici.

La documentazione Javadoc generata sarà disponibile nella cartella dist del tuo progetto. Aprila nel tuo browser per visualizzarla!