Objets¶

Règles¶

1. Comportent au maximum 31 caractères :
   1. Lettres minuscules
   2. Nombres
   3. Trait de soulignement
2. Si plusieurs mots sont utilisés, ils sont séparées par des traits de soulignement
3. Les commentaires Doxygen suivants sont ajoutés
   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
4. Le modificateur static pour les objets ayant une visibilité locale
5. Les objets ne devant plus être utilisés, DOIVENT générer un message lors de la compilation (-Wall) si un appel est effectué.
   1. Les attributsdeprecated ou unavailable DOIVENT être ajoutés à la déclaration.
   2. Les commentaires Doxygen suivants doivent être ajoutés :
      1. @deprecated :
      2. @since :

Exemple¶

/**
 * @brief OldFunction
 * @deprecated Utiliser NewFunction à la place
 * @since Version x.x.xx
 */
int OldFunction(void) __attribute__((deprecated));

/**
 * @brief OldFunction
 * @deprecated Utiliser NewFunction à la place
 * @since Version x.x.xx
 */
int OldFunction(void) __attribute__((unavailable));

/**
* @brief MACRO1
* @deprecated Utiliser NEWMACRO à la place
* @since Version x.x.xx
*/
#define MACRO1 43
#pragma GCC poison MACRO1

/**
 * @brief Fonction locale
 * @return Une valeur
 */
static int local_func(void) {
    ...
    return 0;
}

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-systems/books/embedded-c-coding-standard