Tagger la javadoc...
Par Nicolas, lundi 20 juin 2005 à 15:40 :: geek stuff :: #53 :: rss
C'est les trucs dont on se souvient jamais alors...ils sont ici désormais.
Pour pouvoir être interprétés les tags standards doivent obligatoirement commencer en début de ligne.
Tag | Rôle | élément concerné |
@author | permet de préciser l'auteur de l'élement | classe et interface |
@deprecated | permet de préciser qu'un élément est déprécié | package, classe, interface, méthode et champ |
{@docRoot} | représente le chemin relatif du répertoire principal de génération de la documentation |   |
@exception | permet de préciser une exception qui peut être levée par l'élément | méthode |
{@link} | permet d'inserer un lien vers un élément de la documentation dans n'importe quel texte | package, classe, interface, methode, champ |
@param | permet de préciser un paramètre de l'élément | constructeur et méthode |
@see | permet de préciser un élément en relation avec l'élément documenté | package, classe, interface, champ |
@serial |   | classe, interface |
@serialData |   | methode |
@serialField |   | classe, interface, |
@since | permet de préciser depuis quelle version l'élément aété ajouté | package, classe, interface, méthode et champ |
@throws | identique ´ @exception | méthode |
@version | permet de préciser le numéro de version de l'élément | classe et interface |
@return | permet de préciser la valeur de retour d'un élément | méthode |
 source
Commentaires
Aucun commentaire pour le moment.
Ajouter un commentaire
Les commentaires pour ce billet sont fermés.