Commentaires » Historique » Version 8
Patrice Nadeau, 2024-01-27 16:04
| 1 | 1 | Patrice Nadeau | # Commentaires |
|---|---|---|---|
| 2 | |||
| 3 | ## Règles |
||
| 4 | |||
| 5 | 1. Précède l’élément à documenté, avec la même indentation |
||
| 6 | 1. En minuscules et commence par une majuscule |
||
| 7 | 1. Phrase complète en français |
||
| 8 | 1. Sur une ou plusieurs lignes |
||
| 9 | 1. De style |
||
| 10 | 1. C (/*... */) : Commentaires du code |
||
| 11 | 2 | Patrice Nadeau | 1. Javadoc (/** */, @) : Commentaires devant apparaître dans la documentation (Doxygen) |
| 12 | 5 | Patrice Nadeau | 1. Les « décorations » (gras, italique, etc.) sont faites avec la syntaxe Markdown |
| 13 | * Italique : `∗` ou `_` |
||
| 14 | * Gras : `∗∗` ou `__` |
||
| 15 | 7 | Patrice Nadeau | 1. Les commentaires suivants peuvent aussi être utilisés |
| 16 | * `@todo` |
||
| 17 | * `@bug` |
||
| 18 | 1 | Patrice Nadeau | |
| 19 | ## Exemple |
||
| 20 | |||
| 21 | ```c |
||
| 22 | ... |
||
| 23 | /* Il n'est pas nécessaire de documenter chaque ligne */ |
||
| 24 | 8 | Patrice Nadeau | /** @todo Enlever ce commentaire inutile de la documentation Doxygen */ |
| 25 | 1 | Patrice Nadeau | x++; |
| 26 | ... |
||
| 27 | ``` |
||
| 28 | |||
| 29 | ## Justifications |
||
| 30 | * [Loi sur la langue officielle et commune du Québec, le français](https://www.publicationsduquebec.gouv.qc.ca/fileadmin/Fichiers_client/lois_et_reglements/LoisAnnuelles/fr/2022/2022C14F.PDF) |
||
| 31 | 3 | Patrice Nadeau | * La documentation est partie intégrante du code |