Fichiers » Historique » Version 3
Patrice Nadeau, 2024-01-27 16:47
| 1 | 1 | Patrice Nadeau | # Fichiers |
|---|---|---|---|
| 2 | 2 | Patrice Nadeau | |
| 3 | ## Règles |
||
| 4 | 1 | Patrice Nadeau | Le nom des fichiers DOIT être composé de la manière suivante : |
| 5 | 2 | Patrice Nadeau | 1. Un préfixe de 8 caractères maximum |
| 6 | 1. Lettres minuscule |
||
| 7 | 1. Chiffres |
||
| 8 | 1. Trait de soulignement |
||
| 9 | 1. Un des suffixe suivants : |
||
| 10 | 1. `.h` : entête |
||
| 11 | 1. `.c` : sources |
||
| 12 | 1. Contient une section Doxygen : |
||
| 13 | 1. `@file` : Le nom du fichier |
||
| 14 | 1. `@brief`: Une brève description |
||
| 15 | 1. `@version`: Le numéro de version |
||
| 16 | 1. `@date`: La date de dernière modification |
||
| 17 | 1. `@author`: Une liste des participant(e)s et leur courriel |
||
| 18 | 1. `@copyright`: La liste des années et participant(e)s |
||
| 19 | 1. Les fichiers d’entête contiennent en plus |
||
| 20 | 1. Une définition macro pour éviter de ré-inclure le fichier. |
||
| 21 | 1 | Patrice Nadeau | |
| 22 | 2 | Patrice Nadeau | ## Exemple |
| 23 | 1 | Patrice Nadeau | ```c |
| 24 | /** |
||
| 25 | 2 | Patrice Nadeau | #ifndef _usart_h |
| 26 | #define _usart_h |
||
| 27 | /** |
||
| 28 | * @file : test.h |
||
| 29 | 1 | Patrice Nadeau | * @brief ATMEL AVR 8-bit C librairie |
| 30 | 2 | Patrice Nadeau | * @version 0.00.01 |
| 31 | * @date 2023-02-26 |
||
| 32 | * @author Patrice Nadeau <pnadeau@patricenadeau.com> |
||
| 33 | * @copyright 2023 Patrice Nadeau |
||
| 34 | 1 | Patrice Nadeau | * @pre AVR supportés (testés en gras) : |
| 35 | * - ATmega88 |
||
| 36 | * - ATmega168 |
||
| 37 | * - **ATmega328P** |
||
| 38 | */ |
||
| 39 | |||
| 40 | ... |
||
| 41 | |||
| 42 | 2 | Patrice Nadeau | #endif /*_usart_h*/ |
| 43 | 1 | Patrice Nadeau | ``` |