Fichiers » Historique » Révision 3
Révision 2 (Patrice Nadeau, 2024-01-27 14:18) → Révision 3/9 (Patrice Nadeau, 2024-01-27 16:47)
# Fichiers
## Règles
Le nom des fichiers DOIT être composé de la manière suivante :
1. Un préfixe de 8 caractères maximum
1. Lettres minuscule
1. Chiffres
1. Trait de soulignement
1. Un des suffixe suivants :
1. `.h` : entête
1. `.c` : sources
1. Contient une section Doxygen :
1. `@file` : Le nom du fichier
1. `@brief`: Une brève description
1. `@version`: Le numéro de version
1. `@date`: La date de dernière modification
1. `@author`: Une liste des participant(e)s et leur courriel
1. `@copyright`: La liste des années et participant(e)s
1. Les fichiers d’entête contiennent en plus
1. Une définition macro pour éviter de ré-inclure le fichier.
## Exemple
```c
#ifndef _test_h
#define _test_h
/**
* @file : test.h
* @brief Description
* @version 0.00.01
* @date 2023-02-26
* @author Patrice Nadeau <pnadeau@patricenadeau.com>
* @copyright 2023 Patrice Nadeau
*/
/**
#ifndef _usart_h
#define _usart_h
/**
* @file : test.h
* @brief ATMEL AVR 8-bit C librairie
* @version 0.00.01
* @date 2023-02-26
* @author Patrice Nadeau <pnadeau@patricenadeau.com>
* @copyright 2023 Patrice Nadeau
* @pre AVR supportés (testés en gras) :
* - ATmega88
* - ATmega168
* - **ATmega328P**
*/
...
#endif /*_usart_h*/
```