Fichiers » Historique » Version 9
Patrice Nadeau, 2024-07-21 11:12
| 1 | 1 | Patrice Nadeau | # Fichiers |
|---|---|---|---|
| 2 | 2 | Patrice Nadeau | |
| 3 | 4 | Patrice Nadeau | Les fichiers suivants sont des exceptions : |
| 4 | 7 | Patrice Nadeau | * `AUTHORS` : Fichier texte des noms et courriels des auteurs |
| 5 | 9 | Patrice Nadeau | * `ChangeLog` : |
| 6 | 8 | Patrice Nadeau | * `config.h` : Contient les macros communes au programme dans son ensemble (-imacros) |
| 7 | 4 | Patrice Nadeau | * `COPYING` : Contient les information de licence |
| 8 | 9 | Patrice Nadeau | * `INSTALL` : |
| 9 | 7 | Patrice Nadeau | * `Makefile.in` : Contient les informations spécifiques du projet pour le Makefile |
| 10 | 9 | Patrice Nadeau | * `NEWS` : |
| 11 | 4 | Patrice Nadeau | * `README` : Contient les informations d'un projet, en format *markdown* |
| 12 | |||
| 13 | 2 | Patrice Nadeau | ## Règles |
| 14 | 1 | Patrice Nadeau | Le nom des fichiers DOIT être composé de la manière suivante : |
| 15 | 5 | Patrice Nadeau | 1. Un préfixe en anglais de 8 caractères maximum |
| 16 | 2 | Patrice Nadeau | 1. Lettres minuscule |
| 17 | 1. Chiffres |
||
| 18 | 1. Trait de soulignement |
||
| 19 | 1. Un des suffixe suivants : |
||
| 20 | 1. `.h` : entête |
||
| 21 | 1. `.c` : sources |
||
| 22 | 1. Contient une section Doxygen : |
||
| 23 | 1. `@file` : Le nom du fichier |
||
| 24 | 1. `@brief`: Une brève description |
||
| 25 | 1. `@version`: Le numéro de version |
||
| 26 | 1. `@date`: La date de dernière modification |
||
| 27 | 1. `@author`: Une liste des participant(e)s et leur courriel |
||
| 28 | 1. `@copyright`: La liste des années et participant(e)s |
||
| 29 | 1. Les fichiers d’entête contiennent en plus |
||
| 30 | 1. Une définition macro pour éviter de ré-inclure le fichier. |
||
| 31 | 1 | Patrice Nadeau | |
| 32 | 2 | Patrice Nadeau | ## Exemple |
| 33 | 1 | Patrice Nadeau | ```c |
| 34 | /** |
||
| 35 | 2 | Patrice Nadeau | #ifndef _usart_h |
| 36 | #define _usart_h |
||
| 37 | /** |
||
| 38 | * @file : test.h |
||
| 39 | 1 | Patrice Nadeau | * @brief ATMEL AVR 8-bit C librairie |
| 40 | 2 | Patrice Nadeau | * @version 0.00.01 |
| 41 | * @date 2023-02-26 |
||
| 42 | 6 | Patrice Nadeau | * @author Patrice Nadeau <pnadeau@patricenadeau.com> |
| 43 | 2 | Patrice Nadeau | * @copyright 2023 Patrice Nadeau |
| 44 | 1 | Patrice Nadeau | * @pre AVR supportés (testés en gras) : |
| 45 | * - ATmega88 |
||
| 46 | * - ATmega168 |
||
| 47 | * - **ATmega328P** |
||
| 48 | */ |
||
| 49 | |||
| 50 | ... |
||
| 51 | |||
| 52 | 2 | Patrice Nadeau | #endif /*_usart_h*/ |
| 53 | 1 | Patrice Nadeau | ``` |