Project

General

Profile

Actions

Identifiants

Règles

  1. Nom
    1. Écris en anglais avec au maximum 31 caractères :
      1. Lettres minuscules
      2. Nombres
      3. Trait de soulignement
    2. Commence par une lettre
    3. Si plusieurs mots sont utilisés, ils sont 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 :
        • 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));

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

Justification

Updated by Patrice Nadeau about 1 month ago · 36 revisions