Wiki »

Fichiers » Historique » Révision 2

Révision 1 (Patrice Nadeau, 2024-01-20 21:20) → Révision 2/9 (Patrice Nadeau, 2024-01-27 14:18)

# Fichiers 

 ## Règles 
 Le nom des fichiers DOIT être composé de la manière suivante : 
 1. * Un préfixe de 8 caractères maximum 
     1. Lettres minuscule 
     1. Chiffres 
     1. Trait de * avec seulement des lettres minuscule, chiffres et soulignement 
 1. * Un des suffixe suivants :  
     1. * `.h` : entête 
     1. * `.c` : sources 
 1. * Contient une section Doxygen : 
     1. * `@file` : Le nom du fichier 
     1. `@brief`: Une brève description * `@brief` 
     1. `@version`: Le numéro de version * `@version` 
     1. `@date`: La date de dernière modification * `@date` 
     1. `@author`: Une liste des participant(e)s et leur courriel * `@author` 
     1. `@copyright`: La liste des années et participant(e)s * `@copyright` 
 1. * Les fichiers d’entête contiennent en plus 
     1. * 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 : 
 ```c 
 #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 
 */ 

 /** 
 #ifndef _usart_h 
 #define _usart_h 
 /** 
  * @file : test.h @mainpage lcd 
  * @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 @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*/ /*_usart.h*/ 
 ```