Projet

Général

Profil

Fichiers » Historique » Version 34

Patrice Nadeau, 2025-06-01 16:06

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