Style » Historique » Version 2
Patrice Nadeau, 2024-01-21 20:31
1 | 1 | Patrice Nadeau | # Style |
---|---|---|---|
2 | |||
3 | 2 | Patrice Nadeau | ## Règles |
4 | 1 | Patrice Nadeau | * L’indentation est de 4 espaces |
5 | 2 | Patrice Nadeau | * Une ligne ne devrait pas avoir plus de 79 caractères |
6 | > La barre oblique inversée doit être utilisée dans les cas d’exception |
||
7 | 1 | Patrice Nadeau | * 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 | 2 | Patrice Nadeau | * [K&R](https://fr.wikipedia.org/wiki/Style_d%27indentation#Style_K&R) variante *one true brace style* (1TBS) |
17 | 1 | Patrice Nadeau | * Prévient les erreurs lors d'ajout dans les boucles n'ayant qu'une instruction comme bloc |
18 | |||
19 | Exemple : |
||
20 | ``` c |
||
21 | int fonction(void) { |
||
22 | int x; |
||
23 | if (var != 1) { |
||
24 | x = x + 1; |
||
25 | y++; |
||
26 | /* Longue ligne */ |
||
27 | printf("This is a long\ |
||
28 | line that should be splitted"); |
||
29 | } else { |
||
30 | x--; |
||
31 | }; |
||
32 | return 0; |
||
33 | } |
||
34 | ``` |