Fichiers » Historique » Version 1
Patrice Nadeau, 2024-01-20 21:20
| 1 | 1 | Patrice Nadeau | # Fichiers |
|---|---|---|---|
| 2 | Le nom des fichiers DOIT être composé de la manière suivante : |
||
| 3 | * Un préfixe de 8 caractères maximum |
||
| 4 | * avec seulement des lettres minuscule, chiffres et soulignement |
||
| 5 | * Un des suffixe suivants : |
||
| 6 | * `.h` : entête |
||
| 7 | * `.c` : sources |
||
| 8 | * Contient une section Doxygen : |
||
| 9 | * `@file` |
||
| 10 | * `@brief` |
||
| 11 | * `@version` |
||
| 12 | * `@date` |
||
| 13 | * `@author` |
||
| 14 | * `@copyright` |
||
| 15 | * Les fichiers d’entête contiennent en plus |
||
| 16 | * Une définition macro pour éviter de ré-inclure le fichier. |
||
| 17 | * Le fichier d’entête du projet contient en plus |
||
| 18 | * Une section Doxygen « mainpage » |
||
| 19 | |||
| 20 | Exemple : |
||
| 21 | ```c |
||
| 22 | #ifndef _test_h |
||
| 23 | #define _test_h |
||
| 24 | /** |
||
| 25 | * @file : test.h |
||
| 26 | * @brief Description |
||
| 27 | * @version 0.00.01 |
||
| 28 | * @date 2023-02-26 |
||
| 29 | * @author Patrice Nadeau <pnadeau@patricenadeau.com> |
||
| 30 | * @copyright 2023 Patrice Nadeau |
||
| 31 | */ |
||
| 32 | |||
| 33 | /** |
||
| 34 | * @mainpage lcd |
||
| 35 | * @brief ATMEL AVR 8-bit C librairie |
||
| 36 | * @author Patrice Nadeau <pnadeau@patricenadeau.com> |
||
| 37 | * @version 0.0.02 |
||
| 38 | * @date 2023-03-27 |
||
| 39 | * @pre AVR supportés (testés en gras) : |
||
| 40 | * - ATmega88 |
||
| 41 | * - ATmega168 |
||
| 42 | * - **ATmega328P** |
||
| 43 | * @copyright |
||
| 44 | * @include{doc} LICENSE.txt |
||
| 45 | */ |
||
| 46 | |||
| 47 | ... |
||
| 48 | |||
| 49 | #endif /*_usart.h*/ |
||
| 50 | ``` |