Projet

Général

Profil

Commentaires » Historique » Version 2

Patrice Nadeau, 2024-01-27 15:48

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 1 Patrice Nadeau
13
## Exemple
14
15
```c
16
...
17
/* Il n'est pas nécessaire de documenter chaque ligne */
18
/** Ce commentaire apparaîtra dans la documentation Doxygen */
19
x++;
20
...
21
```
22
23
## Justifications
24
* [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)