Actions
Identifiants¶
Règles¶
- Nom
- En anglais, maximum de 31 caractères :
- Lettres minuscules
- Nombres
- Trait de soulignement
- Commence par une lettre
- Si plusieurs mots sont utilisés, ils DOIVENT être séparées par des traits de soulignement
- En anglais, maximum de 31 caractères :
- Déclaration
- Un objet ayant une visibilité locale DOIT avoir le modificateur
static
- Un objet « obsolète », DOIT avoir :
- Un des attributs :
deprecated
unavailable
- Les commentaires Doxygen :
@deprecated
: Indications sur le remplacement à utiliser@since
: Depuis quel version le changement est apparue
- Un des attributs :
- Un objet ayant une visibilité locale DOIT avoir le modificateur
- Commentaires Doxygen :
@brief
: Description obligatoire@sa
: Lien vers une autre item (see also), facultatif@todo
: Notes sur les tachés à faire, facultatif@bug
: Notes sur les bogues présents, facultatif- 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¶
- 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
- Génération de message lors de la compilation (
-Wall
)
Mis à jour par Patrice Nadeau il y a 2 mois · 37 révisions