Identifiants¶

TODO : library name + module name + action + subject

1. En anglais américain, maximum de 31 caractères :
   • Lettres
     • Macros :
       • Majuscules et minuscules

         La parie principale DOIT être en majuscule

     • Fonctions, variables, énumérations, structures, définition de type :
       • Minuscules
   • Nombre
   • Commence par une lettre
   • Si plusieurs mots sont utilisés, ils DOIVENT être séparées par des traits de soulignement
2. Déclaration
   1. Un objet ayant une visibilité locale DOIT avoir le modificateur static
   2. Un objet « obsolète », DOIT avoir :
      1. Un des attributs :

         Génération de message lors de la compilation (-Wall)

         • deprecated
         • unavailable
      2. Les commentaires Doxygen :
         • @deprecated : Indications sur le remplacement à utiliser
         • @since : Depuis quel version le changement est apparue
3. Commentaires Doxygen :
   1. @brief : Description obligatoire
   2. @sa : Lien vers une autre item (see also), facultatif
   3. @todo : Notes sur les tachés à faire, facultatif
   4. @bug : Notes sur les bogues présents, facultatif
   5. La gradations des notes et remarques se fait selon :
      • @remark : Non importante
      • @note : Général
      • @attention : Important
      • @warning : Conséquence négative

Exemple¶

/**
 * @brief old_function
 * @deprecated Cette fonction seras retirée, utiliser new_function à la place
 * @since Version x.x.xx
 */
int old_function(void) __attribute__ ((deprecated ("Voir new_function()")));

/**
 * @brief older_function
 * @deprecated Cette fonction est retirée, utiliser new_function à la place
 * @since Version x.x.xx
 */
int older_function(void) __attribute__ ((unavailable ("Voir new_function()")));

Justification¶

• Linux kernel coding style : https://www.kernel.org/doc/html/v4.10/process/coding-style.html#naming
• GNU Coding Standards https://www.gnu.org/prep/standards/html_node/Writing-C.html#Writing-C
• Embedded C Coding Standard : https://barrgroup.com/embedded-c-coding-standard