« Java/Annexe/Documenter un programme » : différence entre les versions

Contenu supprimé Contenu ajouté
Aucun résumé des modifications
Ligne 53 :
* @param nombres Le tableau des nombres dont on calcule la somme.
* @return La somme des nombres du tableau.
*/
public int somme(int[] nombres)
</syntaxhighlight>
 
=== Exceptions ===
 
Chaque type d'exception lançable par la méthode doit également être documenté : décrire dans quelles circonstances ce type d'exception est lancé, et si possible comment résoudre le problème.
 
Syntaxe :
@throws ''type'' ''description''
 
Ou
@exception ''type'' ''description''
 
Exemple :
 
<syntaxhighlight lang="Java" highlight="5">
/**
* Calcul de la somme des nombres d'un tableau.
* @param nombres Le tableau des nombres dont on calcule la somme.
* @return La somme des nombres du tableau.
* @throws ListeVideException La liste des nombres est vide.
*/
public int somme(int[] nombres) throws ListeVideException
</syntaxhighlight>
 
=== Références à d'autres méthodes ===
 
Il est recommandé d'ajouter des références aux méthodes relatives au même groupe d'opérations, aux classes fortement liées...
 
Syntaxe (recommandé) :
@see ''ref''
 
Syntaxe :
@see ''ref'' ''texte''
 
;''texte'':Le texte définit ce qui est affiché.
:Il est optionnel et en son absence, la référence est affiché.
:Il est recommandé de ne pas afficher de texte alternatif et de laisser la référence visible.
 
;''ref'':La référence est le nom de la classe suivi du nom du membre de la classe, séparés par le caractère <code>#</code>.
:La classe n'est pas nécessaire quand le membre est dans la même classe.
:Il peut s'agir aussi du nom de la classe pour faire référence à la classe au lieu d'un membre particulier.
:Quand il s'agit d'une méthode, le nom du membre doit être suivi de la liste des paramètres entre parenthèses.
 
La plupart des IDE permettent une auto-complétion pour les références.
 
Exemple :
 
<syntaxhighlight lang="Java" highlight="5">
/**
* Calcul de la somme des nombres d'un tableau.
* @param nombres Le tableau des nombres dont on calcule la somme.
* @return La somme des nombres du tableau.
* @see #produit(int[])
*/
public int somme(int[] nombres)