Fichiers » Historique » Révision 45
Révision 44 (Patrice Nadeau, 2025-11-02 09:39) → Révision 45/48 (Patrice Nadeau, 2025-11-02 09:39)
# Fichiers
Format selon la commande `tree --charset ascii`
## Projet
Structure des répertoires et fichiers
```
.
|-- AUTHORS : Fichier contenant les noms et courriels des auteurs
|-- bin : Répertoire contenant le fichier exécutable et les librairies compilées
|-- ChangeLog : Fichier des changements
|-- config.h : Fichier optionel contenant les macros communes au programme dans son ensemble (-imacros)
|-- COPYING : Fichier de licence (standard GNU)
|-- docs : Répertoire de la documentation (.pdf)
|-- include : Répertoire des fichiers d’en-tête (.h)
|-- INSTALL
|-- lib : Répertoire des libraires externes (liens symboliques)
|-- Makefile.in : Fichier d'informations spécifiques du projet pour le Makefile
|-- NEWS :
|-- obj : Répertoire contenant les objets (.o)
|-- README : Fichier d'informations du projet, en format markdown
`-- src : Répertoire des fichiers sources (.c)
```
## Fichiers sources
1. Nom du fichier :
* Un préfixe en anglais de 8 caractères maximum pouvant contenir :
* Lettres minuscule
* Chiffres
* Trait de soulignement
* Un des suffixe suivants :
* `.h` : entête
* `.c` : sources
1. Contenus
* 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
* Les fichiers d’entête contiennent en plus
1. Une définition macro pour éviter de ré-inclure le fichier (<https://fr.wikipedia.org/wiki/Include_guard>).
## Exemple
```c
#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*/
```