précédent | suivant | table des matières
|
|
Voir ici
1 Forme d'un commentaire javaDoc
/** * le commentaire * * @tag le commentaire pour le tag */
Le commentaire proprement dit est écrit en HTML
Les tag utilisés sont les suivants :
| @author | L'auteur de la classe, ou de l'interface. |
| @version | La version de la classe ou de l'interface. |
| @param | Méthodes et constructeurs seulement. Le tag est suivi du nom du paramètre, et d'une description du paramètre. |
| @return | Pour les méthodes seulement. Omettre pour les méthodes qui retournent void et pour les constructeurs. |
| @deprecated | Le tag @deprecated doit décrire la version depuis laquelle cette méthode ou cette classe est dépréciée, et ce qu'il faut utiliser à la place. |
| @since | ce tag permet de dire depuis quelle version cette méthode, classe ou interface existe. |
| @exception | Un tag pour chaque exception qui peut être levée par l'appel de la méthode ou du constructeur. |
| @see | C'est la référence « voir aussi » … La référence peut être :
|
2 La commande javadoc
La commande se construit de la façon suivante :
javadoc [options] [packagenames] [sourcefiles] [classnames] [@files]
Les options sont :
Les options de la doclet standard sont :
3 Exemples
la commande
javadoc X.java -private Loading source file X.java... Constructing Javadoc information... Standard Doclet version 1.6.0 Building tree for all the packages and classes... Generating X.html... Generating package-frame.html... Generating package-summary.html... Generating package-tree.html... Generating constant-values.html... Building index for all the packages and classes... Generating overview-tree.html... Generating index-all.html... Generating deprecated-list.html... Building index for all classes... Generating allclasses-frame.html... Generating allclasses-noframe.html... Generating index.html... Generating help-doc.html... Generating stylesheet.css... |
appliquée au fichier :
/** * Classe exemple pour javadoc * @author bcaylux * @version 1.0 */ public class X { /** * Un entier à visibilité paquetage */ int a; /** * Un entier à visibilité privée */ private int b; /** * Un constructeur avec un entier * en paramètre, et qui lève * une exception. * @param n un entier * @throws Exception */ public X (int n)throws Exception{ a = n; } /** * La méthode main ... * @param args les arguments * de la méthode main */ public static void main (String[] args){ try { X x = new X(2); } catch (Exception e) { } } } |
Génère la liste des fichiers :
allclasses-frame.html allclasses-noframe.html constant-values.html deprecated-list.html help-doc.html index-all.html index.html overview-tree.html package-frame.html package-list package-summary.html package-tree.html stylesheet.css X.html
la commande
javadoc -verbose @fichiers.txt -d doc
Avec un fichier fichiers.txt contenant :
paquetage \A.java paquetage \B.java …
Le système de documentation est rangé dans le répertoire doc
4 Conseils destyle :
Voir ici.
5 Javadoc sous eclipse
Le menu Projet/Générer le javadoc permet d'obtenir le fenêtre suivante :
La fenêtre suivante permet de configurer les options du doclet standard.
La dernière fenêtre permet de donner les options de la commande javadoc.
