Fichiers » Historique » Version 48
Patrice Nadeau, 2025-11-02 09:43
| 1 | 1 | Patrice Nadeau | # Fichiers |
|---|---|---|---|
| 2 | 2 | Patrice Nadeau | |
| 3 | 1 | Patrice Nadeau | ## Projet |
| 4 | Structure des répertoires et fichiers |
||
| 5 | 48 | Patrice Nadeau | |
| 6 | > Format selon la commande `tree --charset ascii` |
||
| 7 | 44 | Patrice Nadeau | |
| 8 | 11 | Patrice Nadeau | ``` |
| 9 | 33 | Patrice Nadeau | . |
| 10 | 36 | Patrice Nadeau | |-- AUTHORS : Fichier contenant les noms et courriels des auteurs |
| 11 | 31 | Patrice Nadeau | |-- bin : Répertoire contenant le fichier exécutable et les librairies compilées |
| 12 | 1 | Patrice Nadeau | |-- ChangeLog : Fichier des changements |
| 13 | 32 | Patrice Nadeau | |-- config.h : Fichier optionel contenant les macros communes au programme dans son ensemble (-imacros) |
| 14 | 1 | Patrice Nadeau | |-- COPYING : Fichier de licence (standard GNU) |
| 15 | 33 | Patrice Nadeau | |-- docs : Répertoire de la documentation (.pdf) |
| 16 | 31 | Patrice Nadeau | |-- include : Répertoire des fichiers d’en-tête (.h) |
| 17 | 26 | Patrice Nadeau | |-- INSTALL |
| 18 | 43 | Patrice Nadeau | |-- lib : Répertoire des libraires externes (liens symboliques) |
| 19 | 31 | Patrice Nadeau | |-- Makefile.in : Fichier d'informations spécifiques du projet pour le Makefile |
| 20 | 36 | Patrice Nadeau | |-- NEWS : |
| 21 | 34 | Patrice Nadeau | |-- obj : Répertoire contenant les objets (.o) |
| 22 | |-- README : Fichier d'informations du projet, en format markdown |
||
| 23 | 4 | Patrice Nadeau | `-- src : Répertoire des fichiers sources (.c) |
| 24 | ``` |
||
| 25 | 1 | Patrice Nadeau | |
| 26 | 44 | Patrice Nadeau | ## Fichiers sources |
| 27 | 42 | Patrice Nadeau | 1. Nom du fichier : |
| 28 | * Un préfixe en anglais de 8 caractères maximum pouvant contenir : |
||
| 29 | * Lettres minuscule |
||
| 30 | * Chiffres |
||
| 31 | * Trait de soulignement |
||
| 32 | * Un des suffixe suivants : |
||
| 33 | * `.h` : entête |
||
| 34 | * `.c` : sources |
||
| 35 | 1. Contenus |
||
| 36 | * Section Doxygen : |
||
| 37 | 1. `@file` : Le nom du fichier |
||
| 38 | 1. `@brief`: Une brève description |
||
| 39 | 1. `@version`: Le numéro de version |
||
| 40 | 1. `@date`: La date de dernière modification |
||
| 41 | 1. `@author`: Une liste des participant(e)s et leur courriel |
||
| 42 | 1. `@copyright`: La liste des années et participant(e)s |
||
| 43 | * Les fichiers d’entête contiennent en plus |
||
| 44 | 1. Une définition macro pour éviter de ré-inclure le fichier (<https://fr.wikipedia.org/wiki/Include_guard>). |
||
| 45 | 1 | Patrice Nadeau | |
| 46 | 46 | Patrice Nadeau | ### Exemple |
| 47 | 1 | Patrice Nadeau | ```c |
| 48 | 47 | Patrice Nadeau | #ifndef _test_h |
| 49 | #define _test_h |
||
| 50 | 40 | Patrice Nadeau | |
| 51 | 2 | Patrice Nadeau | /** |
| 52 | * @file : test.h |
||
| 53 | 1 | Patrice Nadeau | * @brief ATMEL AVR 8-bit C librairie |
| 54 | 2 | Patrice Nadeau | * @version 0.00.01 |
| 55 | * @date 2023-02-26 |
||
| 56 | 6 | Patrice Nadeau | * @author Patrice Nadeau <pnadeau@patricenadeau.com> |
| 57 | 2 | Patrice Nadeau | * @copyright 2023 Patrice Nadeau |
| 58 | 1 | Patrice Nadeau | * @pre AVR supportés (testés en gras) : |
| 59 | * - ATmega88 |
||
| 60 | * - ATmega168 |
||
| 61 | * - **ATmega328P** |
||
| 62 | */ |
||
| 63 | |||
| 64 | ... |
||
| 65 | |||
| 66 | 47 | Patrice Nadeau | #endif /*_test_h*/ |
| 67 | 1 | Patrice Nadeau | ``` |