Actions
Commentaires¶
Règles¶
- Précède l’élément à documenté, avec la même indentation
- En minuscules et commence par une majuscule
- Phrase complète en français
- Sur une ou plusieurs lignes
- De style
- C (/*... */) : Commentaires du code
- Javadoc (/** */, @) : Commentaires devant apparaître dans la documentation (Doxygen)
- Les « décorations » (gras, italique, etc.) sont faites avec la syntaxe Markdown
- Italique :
∗
ou_
- Gras :
∗∗
ou__
- Italique :
- Les commentaires suivants peuvent aussi être utilisés
@todo
@bug
- Les « décorations » (gras, italique, etc.) sont faites avec la syntaxe Markdown
Exemple¶
...
/* Il n'est pas nécessaire de documenter chaque ligne */
/** @todo Enlever ce commentaire inutile de la documentation Doxygen */
x++;
...
Justifications¶
- Loi sur la langue officielle et commune du Québec, le français
- La documentation est partie intégrante du code
Mis à jour par Patrice Nadeau il y a 7 mois · 8 révisions