Actions
Fichiers¶
Les fichiers suivants sont des exceptions :
AUTHORS
: Fichier texte des noms et courriels des auteursChangeLog
:config.h
: Contient les macros communes au programme dans son ensemble (-imacros)COPYING
: Contient les information de licenceINSTALL
:Makefile.in
: Contient les informations spécifiques du projet pour le MakefileNEWS
:README
: Contient les informations d'un projet, en format markdown
Règles¶
Le nom des fichiers DOIT être composé de la manière suivante :
- Un préfixe en anglais de 8 caractères maximum
- Lettres minuscule
- Chiffres
- Trait de soulignement
- Un des suffixe suivants :
.h
: entête.c
: sources
- Contient une section Doxygen :
@file
: Le nom du fichier@brief
: Une brève description@version
: Le numéro de version@date
: La date de dernière modification@author
: Une liste des participant(e)s et leur courriel@copyright
: La liste des années et participant(e)s
- Les fichiers d’entête contiennent en plus
- Une définition macro pour éviter de ré-inclure le fichier.
Exemple¶
/**
#ifndef _usart_h
#define _usart_h
/**
* @file : test.h
* @brief ATMEL AVR 8-bit C librairie
* @version 0.00.01
* @date 2023-02-26
* @author Patrice Nadeau <pnadeau@patricenadeau.com>
* @copyright 2023 Patrice Nadeau
* @pre AVR supportés (testés en gras) :
* - ATmega88
* - ATmega168
* - **ATmega328P**
*/
...
#endif /*_usart_h*/
Mis à jour par Patrice Nadeau il y a environ 2 mois · 9 révisions