Java mette a disposizione un tool javadoc ,
che produce la documentazzione ai programmi in modo standard. Occorre seguire
alcune semplici regole quando si inseriscono i commenti:
- Commentare ogni metodo.
- usando i caratteri
/** e */ per segnalare
l'inizio e la fine del commento. Una semplice riga di commento che spiega
cosa fa il metodo.
- Commentare i parametri.
- se il metodo ha dei parametri inserire
@param nome_parametro
seguito dal commento sul significato del parametro. Una riga per ciascun parametro.;
- Commentare i valori di rientro.
- se il metodo riporta un valore allora va documentato il significato del
valore di rientro. Su una riga inserire
@return seguito dalla
descrizione del valore;
- Eseguire il comando
javadoc NomeClasse.java .
- il comando avvia un processo di compilazione e di creazione di file
html
che poi possono essere ispezionati con un browser. Se si esegue il comando
javadcoc *.java si compila la documentazione di tutte le classi
della directory in cui viene eseguito il comando.
Ad esempio avendo eseguito il comando
javadoc Macchina.java sono stati creati numerosi file che visualizzano
la documentazione della classe. Tra questi:
Macchina.html .
La tabella riassuntiva della classe Macchina.java .
index.html .
La pagina che richiama la documentazione di tutte le classi java della cartella.
|