Mémo Javadoc - Camille Sauvaget Blog

Mémo Javadoc
Commentaire Javadoc
/**
* Texte décrivant la méthode, classe, ...
* @tags
*/
Tags Javadoc
@param
Paramètre(s) de la méthode
@param monParametre
A quoi correspond le paramètre.
@return
Objet retourné par la méthode
@return la valeur retournée correspond à ...
@throws
Exceptions levées par la méthode
@throws Exception Exception levée lorsque …
@author
Auteur de la classe, plusieurs tag @author peuvent être insérés
@author AGreatMan
@version
Version de la classe
@version 4.2
@see
Référence à une autre classe, méthode, etc... Se présente sous la forme d'un lien
dans un bloc « See also ».
@see Manual
Crée une référence vers Manual, affichée comme texte.
@see <a href=“URL#value”>label</a>
Créé un lien relatif ou absolu vers une ressource externe.
@see package.class#member label
Créé un lien vers l'élément dans le code java.
@since
Indique depuis quelle version de la classe la méthode est présente
@since 1.2
@deprecated
Indique qu'une méthode est dépréciée, et ce qu'il convient d'utiliser
@deprecated Depuis 1.56, remplacé par nouvelleMethode()
{@code ...}
Affiche du code, les caractères HTML ne sont pas interprétés.
{@docRoot}
Chemin relatif vers le document généré. Utile pour créer des liens.
{@inheritDoc} Insère les commentaire issus de l'héritage à cet endroit.
{@link}
Créé un lien vers un élément de la documentation. Ce tag fonctionne comme
@see à la différence que le lien résultant sera affiché dans la page et non pas dans
le bloc « See Also ».
{@linkplain}
Comme @link, ce tag permet de créer un lien mais dont l'affichage sera comme
du texte standard.
{@literal ...}
Affiche du texte, les caractères HTML ne sont pas interprétés.
{@literal > Ceci est un texte qui sera affiché. < }
Mémo Javadoc
Page 1/2
Camille SAUVAGET
@serial
@serialData
@serialField
Utilisation des tags
Les tags peuvent être présent à plusieurs niveaux dans le code java. Les différents niveaux
sont définis en fonction de l'emplacement du commentaire dans le fichier source.
Overview
Lorsque le commentaire Javadoc se situe en haut du fichier java.
Package
Le commentaire est situé juste avant la ligne package.
Class/Interface Le commentaire est situé juste avant la déclaration d'une classe ou interface.
Field
Le commentaire est situé juste avant la déclaration d'un membre.
Method
Le commentaire est situé juste avant la déclaration d'une méthode.
Suivant le niveau certains tags sont acceptés d'autres non. L'utilisation des tags en fonction
du niveau d'utilisation est résumé dans le tableau ci-dessous.
Tags
Overview
Package
Class/Interface
Field
Method
@param
√
@return
√
@throws
√
@author
√
√
√
@version
√
√
√
@see
√
√
√
√
√
@since
√
√
√
√
√
√
√
√
@deprecated
{@code ...}
√
√
√
√
√
{@docRoot}
√
√
√
√
√
{@inheritDoc}
√
{@link}
√
√
√
√
√
{@linkplain}
√
√
√
√
√
{@literal ...}
√
√
√
√
√
√
√
√
@serial
@serialData
√
@serialField
√
Page dédiée sur le site de Sun http://java.sun.com/javase/6/docs/technotes/tools/solaris/javadoc.html.
Un tutoriel sur developpez.com http://simonandre.developpez.com/tutoriels/java/presentation-javadoc/.
Mémo Javadoc
Page 2/2
Camille SAUVAGET