Projet

Général

Profil

Fichiers » Historique » Version 5

Patrice Nadeau, 2024-01-28 10:35

1 1 Patrice Nadeau
# Fichiers
2 2 Patrice Nadeau
3 4 Patrice Nadeau
Les fichiers suivants sont des exceptions :
4
* `COPYING` : Contient les information de licence
5
* `README` : Contient les informations d'un projet, en format *markdown*
6
* `config.h` :
7
8 2 Patrice Nadeau
## Règles
9 1 Patrice Nadeau
Le nom des fichiers DOIT être composé de la manière suivante :
10 5 Patrice Nadeau
1. Un préfixe en anglais de 8 caractères maximum
11 2 Patrice Nadeau
    1. Lettres minuscule
12
    1. Chiffres
13
    1. Trait de soulignement
14
1. Un des suffixe suivants : 
15
    1. `.h` : entête
16
    1. `.c` : sources
17
1. Contient une section Doxygen :
18
    1. `@file` : Le nom du fichier
19
    1. `@brief`: Une brève description
20
    1. `@version`: Le numéro de version
21
    1. `@date`: La date de dernière modification
22
    1. `@author`: Une liste des participant(e)s et leur courriel
23
    1. `@copyright`: La liste des années et participant(e)s
24
1. Les fichiers d’entête contiennent en plus
25
    1. Une définition macro pour éviter de ré-inclure le fichier.
26 1 Patrice Nadeau
27 2 Patrice Nadeau
## Exemple
28 1 Patrice Nadeau
```c
29
/**
30 2 Patrice Nadeau
#ifndef _usart_h
31
#define _usart_h
32
/**
33
 * @file : test.h
34 1 Patrice Nadeau
 * @brief ATMEL AVR 8-bit C librairie
35 2 Patrice Nadeau
 * @version 0.00.01
36
 * @date 2023-02-26
37
 * @author Patrice Nadeau  <pnadeau@patricenadeau.com>
38
 * @copyright 2023 Patrice Nadeau
39 1 Patrice Nadeau
 * @pre AVR supportés (testés en gras) :
40
 * - ATmega88
41
 * - ATmega168
42
 * - **ATmega328P**
43
*/
44
45
...
46
47 2 Patrice Nadeau
#endif /*_usart_h*/
48 1 Patrice Nadeau
```