Javadoc: differenze tra le versioni

Versione delle 22:30, 22 nov 2024

Versione attuale delle 22:34, 22 nov 2024

Riga 2:

== Storia ==

Javadoc nacque come strumento interno utilizzato dai ricercatori della Sun che stavano lavorando alla creazione del linguaggio Java e delle sue librerie; la grande mole di sorgenti spinse alcuni membri deldella teamsquadra a creare un programma per la generazione automatica di documentazione [[HTML]]. Questo formato infatti consente una navigazione molto efficace e veloce, è molto conosciuto dai programmatori ed è facilmente indicizzabile dai [[motore di ricerca|motori di ricerca]]. Tuttavia, la creazione e manutenzione di una tale mole di pagine [[World Wide Web|web]] non sarebbe stata pensabile senza l'aiuto di un sistema automatico: basti pensare alla quantità di riferimenti incrociati che ci sono fra le [[classe (informatica)|classi]] ([[ereditarietà (informatica)|ereditarietà]] fra classi, [[Firma (programmazione)|firme]] dei metodi, riferimenti a ''[[packageMetodo (Javaprogrammazione)|packagemetodi]]'', riferimenti a package solo per citarne alcuni) e agli inevitabili errori di battitura a cui si va incontro scrivendo documentazione. Javadoc nacque quindi per permettere ai programmatori di inserire dei frammenti HTML nei commenti (ignorati quindi dal [[compilatore]]): già con le prime versioni si potevano inserire le descrizioni di ogni classe e dei suoi metodi, nonché il significato dei [[Variabile (informatica)|parametri]] e delle variabili membro.

Con il progredire delle versioni Javadoc diventò sempre più sofisticato e ricco di funzioni:

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 <code>/**</code> e <code>*/</code> (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.

Lista dei [[Tag (metadato)|tag]] di Javadoc:

Riga 28:

|<code>@deprecated</code> || (vedere sopra) indica che l'elemento potrà essere eliminato da una versione successiva del software.

|-

|<code>@exception</code> || Indica eccezioni lanciate da un metodo; cf. <code>@throws</code>.

|-

|<code>@link</code> || Crea un collegamento ipertestuale alla documentazione locale o a risorse esterna (tipicamente internet).

Riga 34:

|<code>@param</code> || Definisce i parametri di un metodo. Richiesto per ogni parametro.

|-

|<code>@return</code> || Indica i valori di ritorno di un metodo. Questo tag non va usato per metodi o costruttori che restituiscono ''{{Codice|codice=void''|linguaggio=Java}}.

|-

|<code>@see</code> || Indica un'associazione a un altro metodo o classe.

Riga 40:

|<code>@since</code> || Indica quando un metodo è stato aggiunto a una classe.

|-

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

|-

|<code>@version</code> || Indica il numero di versione di una classe o un metodo.