Wiki »

Commentaires » Historique » Révision 7

Révision 6 (Patrice Nadeau, 2024-01-27 15:54) → Révision 7/8 (Patrice Nadeau, 2024-01-27 16:03)

# Commentaires 

 

 ## Règles 

 1. Précède l’élément à documenté, avec la même indentation 
 1. En minuscules et commence par une majuscule 
 1. Phrase complète en français 
 1. Sur une ou plusieurs lignes 
 1. De style 
     1. C (/*... */) : Commentaires du code 
     1. 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 `__` 
         1. Les commentaires suivants peuvent aussi être utilisés 
             * `@todo` 
             * `@bug` 

 

 ## Exemple 

 ```c 
 ... 
 /* 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](https://www.publicationsduquebec.gouv.qc.ca/fileadmin/Fichiers_client/lois_et_reglements/LoisAnnuelles/fr/2022/2022C14F.PDF) 
 * La documentation est partie intégrante du code