Commentaires¶

Règles¶

1. Précède l’élément à documenté, avec la même indentation
2. En minuscules et commence par une majuscule
3. Phrase complète en français
4. Sur une ou plusieurs lignes
5. De style
   1. C (/*... */) : Commentaires du code
   2. Javadoc (/** */, @) : Commentaires devant apparaître dans la documentation (Doxygen)
      1. Les « décorations » (gras, italique, etc.) sont faites avec la syntaxe Markdown
         • Italique : ∗ ou _
         • Gras : ∗∗ ou __
      2. Les commentaires suivants peuvent aussi être utilisés
         • @todo
         • @bug

Exemple¶

...
/* Il n'est pas nécessaire de documenter chaque ligne */
/** @brief Ce commentaire apparaîtra dans 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