Project

General

Profile

Actions

Fichiers

Les fichiers suivants sont des exceptions :

  • AUTHORS : Fichier texte des noms et courriels des auteurs
  • config.h : Contient les macros communes au programme dans son ensemble (-imacros)
  • COPYING : Contient les information de licence
  • Makefile.in : Contient les informations spécifiques du projet pour le Makefile
  • README : Contient les informations d'un projet, en format markdown

Règles

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

  1. Un préfixe en anglais de 8 caractères maximum
    1. Lettres minuscule
    2. Chiffres
    3. Trait de soulignement
  2. Un des suffixe suivants :
    1. .h : entête
    2. .c : sources
  3. Contient une section Doxygen :
    1. @file : Le nom du fichier
    2. @brief: Une brève description
    3. @version: Le numéro de version
    4. @date: La date de dernière modification
    5. @author: Une liste des participant(e)s et leur courriel
    6. @copyright: La liste des années et participant(e)s
  4. Les fichiers d’entête contiennent en plus
    1. 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*/

Updated by Patrice Nadeau 28 days ago · 8 revisions