Javadoc: differenze tra le versioni

Versione delle 12:03, 16 mar 2006

Versione delle 13:10, 19 mag 2006

Riga 1:

'''JavaDocJavadoc''' è un [[tool]] incluso nel kit di sviluppo [[Java (linguaggio)|Java]] della [[Sun Microsystems|Sun]], utilizzato per la generazione automatica della documentazione del [[Codice_Codice (informatica)|codice sorgente]].

== Storia ==

Riga 10:

* possibilità di creare le proprie ''Doclet'': estensioni di JavaDoc che permettono di gestire a piacimento le varie fasi di generazione della documentazione

Le ''Doclet'' in particolare permisero ad altre case produttrici di software e ad altri sviluppatori (soprattutto [[Openopen Sourcesource]]) di creare tool molto diversificati:

* generazione di schemi [[UML]], grafi di dipendenze fra classi e package, analizzatori di codice (molto utilizzati nell'[[ingegneria del software]]);

* generazione di documentazione in formato [[PDF]], [[Microsoft Word|Word]], [[richRich textText formatFormat|RTF]], [[Microsoft Help]], [[Latex]], ecc.

Il grande successo di JavaDoc è dovuto alla possibilità di poter creare con facilità una documentazione dall'aspetto professionale, del tutto simile a quella ufficiale, anche da parte del principiante, che impara a valorizzare un aspetto spesso sottovalutato della programmazion che è appunto la gestione dei documenti relativi ai propri programmi. I [[file]] [[HTML]] che vengono generati dalla doclet standard infatti hanno la stessa organizzazione grafica e logica della documentazione che [[Sun Microsystems|Sun]] fornisce per le [[Application Programming Interface|API]] che essa distribuisce.

Riga 19:

Le informazioni di base su package, classi, metodi e campi generate automaticamente possono essere arricchite da ulteriori dettagli per mezzo dei '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;

* @deprecated : (v.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)

[[Categoria:Java]]

[[de:Javadoc]]

[[en:Javadoc]]

[[fr:Javadoc]]

[[nl:Javadoc]]

[[ja:Javadoc]]

[[pt:Javadoc]]