In questo articolo tratteremo come creare commenti sulla documentazione
Java sdk contiene uno strumento che genera la documentazione html dai file sorgente.
Il comando da digitare per generare il codice è
javadoc -d doc *.java
dove doc è il nome della cartella dove si creeranno i documenti
*.java prende tutti i file java
I commenti iniziano con /** e finiscono con */.
Possiamo estrarre la documentazione da
package
classi
metodi
campi
Un commento a un metodo di una classe potrebbe essere
/**
stampa la stringa hello world
*/
public void stampa()
{
System.out.println("hello world");
}
Oltre ai commenti si possono inserire altri campi
@param variabile descrizione
@return descrizione
@throws classe descrizione
@author nome
@version testo
@since testo
@deprecated testo
@see collegamento
@param indica un parametro del metodo
@return indica cosa ritorna il metodo
@throws indica che il metodo puo generare eccezioni
@author nome dell'autore
@version versione del software
@since versione che ha introdotto questa funzione
@deprecated metodo o var che non dovrebbero essere piu usati
@see indica un collegamneto ipertestuale
Vediamo un esempio
/**
Questa classe fa qualche cosa
*/
public class Esempio
{
public static void main(String[] args)
{
new Esempio().stampa("ciao");
}
/**
stampa una stringa
@param nome stringa da stampare
@return non ritorna niente
*/
public void stampa(String nome)
{
System.out.println(nome);
}
}
digitiamo dal prompt
javadoc -d doc *.java
