Fichiers¶

Le nom des fichiers DOIT être composé de la manière suivante :

• Un préfixe de 8 caractères maximum
  • avec seulement des lettres minuscule, chiffres et soulignement
• Un des suffixe suivants :
  • .h : entête
  • .c : sources
• Contient une section Doxygen :
  • @file
  • @brief
  • @version
  • @date
  • @author
  • @copyright
• Les fichiers d’entête contiennent en plus
  • Une définition macro pour éviter de ré-inclure le fichier.
• Le fichier d’entête du projet contient en plus
  • Une section Doxygen « mainpage »

Exemple :

#ifndef _test_h
#define _test_h
/**
 * @file : test.h
 * @brief Description
 * @version 0.00.01
 * @date 2023-02-26
 * @author Patrice Nadeau  <pnadeau@patricenadeau.com>
 * @copyright 2023 Patrice Nadeau
*/

/**
 * @mainpage lcd
 * @brief ATMEL AVR 8-bit C librairie
 * @author Patrice Nadeau <pnadeau@patricenadeau.com>
 * @version 0.0.02
 * @date 2023-03-27
 * @pre AVR supportés (testés en gras) :
 * - ATmega88
 * - ATmega168
 * - **ATmega328P**
 * @copyright 
 * @include{doc} LICENSE.txt
*/

...

#endif /*_usart.h*/