LOGO JAVA

Ingegneria del Software: gruppo 9

Progetto Doclet -  JavaToXmiuml

JAVADOC

 UML ROTATION

Introduzione

Nella versione 1.0 di Java era presente un comando, di nome javadoc che generava la documentazione delle API, in formato HTML per il package o per singoli file sorgenti Java specificati nella linea di comando.
L'output standard del comando generava un file che per ogni classe pubblica passatagli sulla linea di comando, specificando in un file html le sue superclassi, i suoi metodi e attributi pubblici.

Con la versione 1.2 del JDK, è stato introdotto un nuovo Javadoc basato su Doclet.

Il vecchio Javadoc faceva infatti il pharser delle dichiarazioni e della documentazione di commento in un insieme di sorgenti, e produceva un insieme di pagine HTML, che descrivevano le classi, le interfacce, costruttori, metodi e campi.
 

A cosa servono i Doclet


Ora si possono utilizzare i doclet per personalizzare l'output di Javadoc. Un doclet è un programma Java scritto utilizzando anche le API doclet, che forniscono tutti i dati trovati dal pharser nella sua scanzione.
Il doclet specifica quindi, il contenuto e il formato dell'output generato dal tool Javadoc.

Si può scrivere un doclet per generare ogni tipo di file-text di output come HTML, SGML, XML, RTF ecc.
Nel nostro caso verrà progettato uno per creare un file in formato XMI.
SUN provvede quindi, a fornire un doclet "standard" per la generazione di della documentazione il formato HTML (tipo la documentazione delle API).
I doclet possono anche essere usati per fare lavori speciali, non collegati alla produzione di documentazione. Per esempio, un doclet diagnostico, potrebbe operare un check di tutte le classi membre di un "classes" facendo operare Javadoc sui commenti del file.
 

Per maggiori informazioni

Libri
 
Titolo Autore Casa Editrice Data pubbl.
Java in a nutshell David Flanagan O' Really Associates 96

On-line
 
Titolo Autore Sito Breve descrizione
Home Sun Sun http://www.sun.com Sito principale della Sun
Home Java Sun http://java.sun.com Sito principale di Java
Home documentazione JDK 1.2 Sun http://java.sun.com/products/jdk/1.2/docs/index.html Sito Ufficile di documentazione del JDK 1.2
Home documentazione Javadoc Sun http://java.sun.com/products/jdk/javadoc/ Sito Ufficiale di documentazione di Javadoc
Java Discussion Forums - Javadoc Autori Vari http://forum.java.sun.com/forum?folderBy
@220.cLfiaANdlCH^0@.ee76880!skip=24		 Forum di discussione del JDC, occorre essere iscritti, ma l'iscrizione è FREE
Javadoc FAQ Autori Vari http://java.sun.com/products/jdk/javadoc/faq.html
Sun Developer Connection Sun http://www.sun.com/developers/italian/ Servizi per sviluppatori della Sun