Projet

Général

Profil

Fichiers » Historique » Version 33

Patrice Nadeau, 2025-06-01 16:03

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