Projet

Général

Profil

Style » Historique » Révision 2

Révision 1 (Patrice Nadeau, 2024-01-14 11:51) → Révision 2/6 (Patrice Nadeau, 2024-01-21 20:31)

# Style 

 ## Règles Le code DOIT : 
 * Ê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): 
 * L’indentation est de 4 espaces 
 * Une ligne ne devrait pas avoir Le « backslash » est utilisé pour les lignes de plus de 79 80 caractères 
    > La barre oblique inversée doit être utilisée dans les cas d’exception 
 * Une instruction par ligne 
 * Une espace avant et après un opérateur sauf pour les opérateurs « [unaires](https://fr.wikipedia.org/wiki/Op%C3%A9ration_unaire) » 
 * Les commentaires DOIVENT  
     * Précéder l’élément à documenté, avec la même indentation 
     * Être de style C (/* ... */), sur une ou plusieurs lignes 
     * En minuscules et commencer par une majuscule 
     * En français 

 Justifications :  
 * [K&R](https://fr.wikipedia.org/wiki/Style_d%27indentation#Style_K&R) variante *one true brace style* (1TBS) 
 * Prévient les erreurs lors d'ajout dans les boucles n'ayant qu'une instruction comme bloc 
 * Support ASCII 7-bits 
 * Correspondance avec la fiche technique (datasheet) 
 * [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) 

 Exemple : 
 ``` c 
 int fonction(void) { 
     int x; 
     if (var != 1) { 
         x = x + 1; 
         y++; 
         /* Longue ligne */ 
         printf("This is a long\ 
         line that should be splitted"); 
     } else { 
         x--; 
     }; 
     return 0; 
 } 
 ```