Macros et préprocesseur » Historique » Version 3
Patrice Nadeau, 2024-01-27 14:30
| 1 | 1 | Patrice Nadeau | # Macros |
|---|---|---|---|
| 2 | |||
| 3 | ## Règles |
||
| 4 | 1. Comportent au maximum 31 caractères |
||
| 5 | 1. Commence par une lettre |
||
| 6 | 1. Si plusieurs mots sont utilisés, ils sont séparées par des traits de soulignement |
||
| 7 | 1. Les macros ne devant plus être utilisées, DOIVENT générer un message lors de la compilation avec `#pragma GCC poison` |
||
| 8 | 3 | Patrice Nadeau | |
| 9 | 1 | Patrice Nadeau | > Dans ce cas, la documentation doit indiquer le substitut à utiliser |
| 10 | > Pour la définition d’une valeur entière signée (int), un enum DOIT être utilisé. |
||
| 11 | |||
| 12 | ## Exemple |
||
| 13 | ```c |
||
| 14 | /** |
||
| 15 | * @brief MACRO1 |
||
| 16 | * @deprecated Utiliser NEWMACRO à la place |
||
| 17 | * @since Version x.x.xx |
||
| 18 | */ |
||
| 19 | #define MACRO1 43 |
||
| 20 | #pragma GCC poison MACRO1 |
||
| 21 | ``` |
||
| 22 | |||
| 23 | ## Justification |
||
| 24 | 2 | Patrice Nadeau | • [Linux kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html#naming) |
| 25 | • [GNU Coding Standards](https://www.gnu.org/prep/standards/html_node/Writing-C.html#Writing-C) |
||
| 26 | • [Embedded C Coding Standard](https://barrgroup.com/embedded-systems/books/embedded-c-coding-standard) |
||
| 27 | 1 | Patrice Nadeau | • Correspondance avec la fiche technique (datasheet) |