« Java/Annexe/Documenter un programme » : différence entre les versions
Contenu supprimé Contenu ajouté
m Robot : Remplacement de texte automatisé (-\n(==={0,3})(?: *)([^\n=]+)(?: *)\1(?: *)\n +\n\1 \2 \1\n) |
|||
Ligne 27 :
* bla bla ...
*/
Certains IDE (Eclipse par exemple) facilitent la création des commentaires de documentation à la frappe de la touche entrée à la fin de la ligne marquant le début de la documentation <syntaxhighlight lang="Java" inline>/**</syntaxhighlight>
Exemple :
<syntaxhighlight lang="Java">
/**
public int somme(int[] nombres)
</syntaxhighlight>
Après frappe de la touche entrées, l'IDE ajoute un modèle à compléter adapté à l'entité documentée située juste en dessous.
Pour la méthode précédente :
<syntaxhighlight lang="Java">
/**
*
* @param nombres
* @return
*/
public int somme(int[] nombres)
</syntaxhighlight>
Il ne reste plus qu'à compléter les vides : description générale de la méthode, de chaque paramètre et de la valeur retournée.
== Les mots-clés ==
| |||