Projet

Général

Profil

Fichiers » Historique » Version 32

Patrice Nadeau, 2025-06-01 16:01

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