Projet

Général

Profil

Macros et préprocesseur » Historique » Révision 2

Révision 1 (Patrice Nadeau, 2024-01-27 14:28) → Révision 2/17 (Patrice Nadeau, 2024-01-27 14:30)

# Macros 

 ## Règles 
 1. Comportent au maximum 31 caractères 
 1. Commence par une lettre 
 1. Si plusieurs mots sont utilisés, ils sont séparées par des traits de soulignement 
 1. Les macros ne devant plus être utilisées, DOIVENT générer un message lors de la compilation avec `#pragma GCC poison` 
     > Dans ce cas, la documentation doit indiquer le substitut à utiliser 
     > Pour la définition d’une valeur entière signée (int), un enum DOIT être utilisé. 

 ## Exemple 
 ```c 
 /** 
 * @brief MACRO1 
 * @deprecated Utiliser NEWMACRO à la place 
 * @since Version x.x.xx 
 */ 
 #define MACRO1 43 
 #pragma GCC poison MACRO1 
 ``` 

 

 ## Justification 
 • [Linux Linux kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html#naming) style4[GNU GNU Coding Standards](https://www.gnu.org/prep/standards/html_node/Writing-C.html#Writing-C) Standards5[Embedded Embedded C Coding Standard](https://barrgroup.com/embedded-systems/books/embedded-c-coding-standard) Standard6 
 • Correspondance avec la fiche technique (datasheet)