Il contenuto di questi commenti viene estratto da javadoc direttamente dal codice

sorgente e usato per generare automaticamente la documentazione in formato HTML

(quindi la documentazione si pu� esaminare con un browser).

I collegamenti ipertestuali ai metodi e alle sottoclassi vengono creati

automaticamente.

Si possono incorporare nei commenti tag HTML per formattare i commenti o aggiungere
immagini.

I commenti possono essere di classe, attributo o metodo. Un commento di classe

compare subito prima della definizione della classe, un commento di attributo
subito prima della definizione della variabile di istanza e un commento di metodo
subito prima della definizione del metodo. Javadoc elabora i commenti solo per
attributi e metodi public o protected.

Per ogni classe bisogna indicare una breve spiegazione all�inizio della classe.

/**
Scopo della classe
*/
Per ogni attributo (public o protected) bisogna indicare una breve descrizione.

/**
Significato dell�attributo
*/
Per ogni metodo (public o protected) bisogna indicare lo scopo del metodo, poi per
ciascun parametro una riga del tipo @param nomeDelParametro descrizione, infine una
riga che inizia con @return e descrive il valore restituito.

Nei commenti � opportuno indicare anche le precondizioni che devono essere

soddisfatte dai parametri.

/**
Scopo del metodo
@param nome descrizione
@param nome descrizione
@return descrizione
*/
La prima riga (fino al primo punto) viene inserita in una tabella di riepilogo.