« Programmation Java/Commentaires » : différence entre les versions

Contenu supprimé Contenu ajouté
+
Ligne 60 :
}
</source>
 
Le commentaire de documentation se place juste avant l'entité commentée (classe, constructeur, méthode, champ).
 
Dans un commentaire de documentation, la première partie est un texte de description au format HTML.
La seconde partie est une liste d'attributs spéciaux dont le nom commence par un arobase ( @ ).
 
Exemple : pour la méthode suivante :
<source lang="java">
/**
Obtenir la somme de deux entiers.
@param a Le premier nombre entier.
@param b Le deuxième nombre entier.
@return La valeur de la somme des deux entiers spécifiés.
*/
public int somme(int a, int b)
{
return a+b;
}
</source>
;<tt>Obtenir la somme de deux entiers.</tt>:Description de la méthode somme.
;<tt>@param a Le premier nombre entier.</tt>:Attribut de description du paramètre a de la méthode.
;<tt>@param b Le deuxième nombre entier.</tt>:Attribut de description du paramètre b de la méthode.
;<tt>@return La valeur de la somme des deux entiers spécifiés.</tt>:Attribut de description de la valeur retournée par la méthode.
 
Voici une liste non exhaustive des attributs spéciaux:
 
{| class="wikitable" border="1"
! Attribut et syntaxe
! Dans un commentaire de ...
! Description
|-----
| @author ''author''
| classe
| Nom de l'auteur de la classe.
|-{{ligne grise}}
| @version ''version''
| classe
| Version de la classe.
|-----
| @deprecated ''description''
| classe, constructeur, méthode, champ
| Marquer l'entité comme obsolète (ancienne version), décrire pourquoi et par quoi la remplacer.
 
Si l'entité marquée comme obsolète par cet attribut est utilisée, le compilateur donne un avertissement.
|-{{ligne grise}}
| @see ''reference''
| méthode
| Ajouter un lien dans la section "Voir aussi".
|-----
| @param ''id description''
| méthode et constructeur
| Décrire un paramètre de méthode.
|-{{ligne grise}}
| @return ''description''
| méthode
| Décrire la valeur retournée par une méthode.
|-----
| @exception ''type description''
| méthode et constructeur
| Décrire les raisons de lancement d'une exception du type spécifié (clause <tt>throws</tt>).
|}
 
=== Documentation ===