Projet

Général

Profil

Commentaires » Historique » Révision 3

Révision 2 (Patrice Nadeau, 2024-01-27 15:48) → Révision 3/8 (Patrice Nadeau, 2024-01-27 15:49)

# 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) 

 ## Exemple 

 ```c 
 ... 
 /* Il n'est pas nécessaire de documenter chaque ligne */ 
 /** 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