Javadoc: differenze tra le versioni

Versione delle 13:19, 3 mag 2007

Versione delle 13:29, 3 mag 2007

Riga 17:

== Funzionamento ==

Le informazioni di base su package, classi, metodi e campi generate automaticamente possono essere arricchite da ulteriori dettagli per mezzo di «commenti JavaDoc»; questi sono racchiusi fra le sequenze di caratteri /** e */ (di fatto sono una forma particolare di «commento multi-linea»), e vengono aggiunti alla documentazione dell'elemento che li segue. Possono contenere frammenti di [[HTML]] e marcatori (o tag) peculiari di JavaDoc, ecco alcuni esempi:.

* @param, @return, @throws : documentazione relativa a parametri, valori di ritorno ed eccezioni di un metodo;

Lista dei tag di JavaDoc:

* @deprecated : (vedere sopra) indica che l'elemento potrà essere eliminato da una versione successiva del software;

* @link: crea un collegamento ipertestuale alla documentazione locale o a risorse esterna (tipicamente internet)

:{| class="wikitable"

! Tag !! Descrizione

|-

|@author || Nome dello sviluppatore.

|-

* |@deprecated :|| (vedere sopra) indica che l'elemento potrà essere eliminato da una versione successiva del software;.

|-

|@exception || Indica eccezioni lanciate da un metodo; cf. @throws.

|-

* |@link: crea || Crea un collegamento ipertestuale alla documentazione locale o a risorse esterna (tipicamente internet).

|-

|@param || Definisce i parametri di un metodo. Richiesto per ogni parametro.

|-

|@return || Indica i valori di ritorno di un metodo. Questo tag non va usato per metodi o costruttori che restituiscono ''void''.

|-

|@see || Indica un'associazione a un altro metodo o classe.

|-

|@since || Indica quando un metodo è stato aggiunto a una classe.

|-

|@throws || Indica eccezioni lanciate da un metodo. Sinonimo di @exception introdotto in Javadoc 1.2.

|-

|@version || Indica il numero di versione di una classe o un metodo.

|}

'''NB:''' Se si vuole il simbolo '''@''' senza l'intenzione di creare un tag di JavaDoc, si può usare il codice HTML '''@''' per evitare problemi in fase di parsing.

== Collegamenti esterni ==