Javadoc: differenze tra le versioni

Versione delle 18:07, 3 dic 2005

Versione delle 19:02, 9 dic 2005

Riga 1:

{{da aiutare mese|novembre 2005}}

'''JavaDoc''' è un [[tool]] incluso nel kit di sviluppo [[SunJava Microsystems(linguaggio)|SunJava]] chedella generaSun, automaticamenteutilizzato [[file]]per [[html]]la contenentigenerazione laautomatica della documentazione del codice [[Java Codice_(linguaggioinformatica)|Javacodice sorgente]] prodotto.

== Storia ==

I [[file]] [[html]] che vengono generati hanno la stessa organizzazione grafica e logica della documentazione che [[Sun Microsystems|Sun]] fornisce per le [[Application Programming Interface|API]] che essa distribuisce.

Javadoc nacque come tool interno utilizzato dai ricercatori della [[Sun Microsystems|Sun]] che stavano lavoravano 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]] a partire da speciali commenti utilizzati nel codice.

Con il progredire delle versioni ''Javadoc'' è diventato 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.

Il [[tool]] '''Javadoc''' genera la [[documentazione]] estraendo informazioni direttamente dal [[codice (informatica)|codice]] opportunamente scritto tramite dei veri e propri [[Glossario_informatico#Tag | tag]].

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.

== Funzionamento ==

Il [[tool]] '''Javadoc''' genera la [[documentazione]] estraendo informazioni direttamente dal [[codice Codice_(informatica)|codice]] opportunamente scritto tramite dei veri e propri [[Glossario_informatico#Tag | tag]]commentato.

'''JavaDoc''' é un ottimo metodo per la creazione di documentazione [[software]] in quanto il programmatore non deve rivedere tutto il codice per scriverla (il che risulta spesso un'operazione laboriosa) ma scrive la documentazione mentre crea il codice.

Questa maniera di operare, favorisce sia il programmatore che, scrivendo documentazione insieme al codice ha più chiaro ciò che sta facendo potendo spiegare meglio all'utilizzatore del codice il concetto di quello che il codice fa.

In [[linguaggi di programmazione]] come Java la documentazione è fondamentale perchè si può evitare di scrivere molto codice che altre persone hanno già scritto.