Règles de codage C¶

Le langage C utilisé avec le compilateur GCC :

• Standard C99 (-std=c99)
• Extensions GNU
  • attribute((deprecated)) (-Wdeprecated-declaration)
  • attribute((noreturn))
  • #pragma GCC message ""
  • #pragma GCC warning ""
  • #pragma GCC error ""

Identifiants¶

1. Ne DOIT PAS contenir plus de 31 caractères

   ANSI standards

   • a @ z
   • A @ Z
   • 0 @ 9
   • Trait de soulignement (__)

Fichiers

Style

Commentaires¶

1. Précède l’élément à documenté, avec la même indentation
2. En minuscules et commence par une majuscule
3. Phrase complète en français
4. Sur une ou plusieurs lignes
5. De style
   • C (/*... */) : Commentaires du code
   • Javadoc (/** */, @) : Commentaires devant apparaître dans la documentation (Doxygen)

     La documentation est partie intégrante du code

     1. Les « décorations » (gras, italique, etc.) sont faites avec la syntaxe Markdown
        • Italique : ∗ ou _
        • Gras : ∗∗ ou __
     2. Les commentaires suivants peuvent aussi être utilisés
        • @todo
        • @bug

Identifiants

Macros et préprocesseur

Énumérations

Typedef

Variables

Structures

Fonctions

Librairies

Atmel AVR