|
== Storia ==
''Javadoc'' nacque come tool interno utilizzato dai ricercatori della [[Sun Microsystems|Sun]] che stavano lavoravanolavorando alla creazione del linguaggio Java e delle sue librerie; la grande mole di sorgenti spinse alcuni membri del team 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 motori di ricerca. Tuttavia, la creazione e manutenzione di una tale mole di pagine web non sarebbe stata pensabile senza l'aiuto di qualche sistema automatico: basti pensare alla quantità di riferimenti incrociati che ci sono fra le classi ([[ereditarietà]] fra classi, firme dei metodi, riferimenti a partire[[package]] dasolo specialiper 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 utilizzati(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 parametri e delle nelvariabili codicemembro.
Con il progredire delle versioni ''Javadoc'' è diventatodiventò sempre più sofisticato e ricco di funzioni, aggiungendo la possibilità di creare le proprie ''Doclet''. Le ''Doclet'' altro non sono che estensioni di Javadoc che permettono di gestire a piacimento le varie fasi di generazione della documentazione; questa grande flessibilità permise di creare tool in grado di generare schemi [[UML]], documentazione in [[PDF]] e analizzatori di dipendenze.:
* inserimento di link, anche a javadoc esterni;
* inserimento dell'indicazione ''deprecated'' per segnalare classi e/o metodi destinati a scomparire in future versioni del software;
* opzioni per la formattazione avanzata;
* 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 [[Open Source]]) di creare tool molto diversificati:
Il grande successo di Javadoc è dovuto in gran parte alla possibilità di poter creare con facilità una documentazione dall'aspetto professionale, del tutto simile a quella ufficiale. 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. ▼* 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]], [[rich text format|RTF]], [[Microsoft Help]], [[Latex]], ecc.;
▲Il grande successo di Javadoc è dovuto in gran parte 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.
== Funzionamento ==
| 