Style » Historique » Version 1
Patrice Nadeau, 2024-01-14 11:51
| 1 | 1 | Patrice Nadeau | # Style |
|---|---|---|---|
| 2 | |||
| 3 | Le code DOIT : |
||
| 4 | * Être dans le style [K&R](https://fr.wikipedia.org/wiki/Style_d%27indentation#Style_K&R) avec la variante *one true brace style* (1TBS): |
||
| 5 | * L’indentation est de 4 espaces |
||
| 6 | * Le « backslash » est utilisé pour les lignes de plus de 80 caractères |
||
| 7 | * Une instruction par ligne |
||
| 8 | * Une espace avant et après un opérateur sauf pour les opérateurs « [unaires](https://fr.wikipedia.org/wiki/Op%C3%A9ration_unaire) » |
||
| 9 | * Les commentaires DOIVENT |
||
| 10 | * Précéder l’élément à documenté, avec la même indentation |
||
| 11 | * Être de style C (/* ... */), sur une ou plusieurs lignes |
||
| 12 | * En minuscules et commencer par une majuscule |
||
| 13 | * En français |
||
| 14 | |||
| 15 | Justifications : |
||
| 16 | * [K&R](https://fr.wikipedia.org/wiki/Style_d%27indentation#Style_K&R) |
||
| 17 | * Prévient les erreurs lors d'ajout dans les boucles n'ayant qu'une instruction comme bloc |
||
| 18 | * Support ASCII 7-bits |
||
| 19 | * Correspondance avec la fiche technique (datasheet) |
||
| 20 | * [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) |
||
| 21 | |||
| 22 | Exemple : |
||
| 23 | ``` c |
||
| 24 | int fonction(void) { |
||
| 25 | int x; |
||
| 26 | if (var != 1) { |
||
| 27 | x = x + 1; |
||
| 28 | y++; |
||
| 29 | /* Longue ligne */ |
||
| 30 | printf("This is a long\ |
||
| 31 | line that should be splitted"); |
||
| 32 | } else { |
||
| 33 | x--; |
||
| 34 | }; |
||
| 35 | return 0; |
||
| 36 | } |
||
| 37 | ``` |