Node:Conventions de nommage, Next:, Previous:Top, Up:Top


Conventions de nommage

Général

Les identifiants doivent être explicites ou mnémoniques.

Les abréviations sont tolérées dans la mesure où elles permettent de réduire la taille du nom sans en perdre le sens. Les parties des noms composites devraient être séparées par _.

Par exemple : 
#define MAX_LINE_SIZE               1024
#define COMMENT_START_DELIMITER     '#'
#define MAX_FILE_NAME_LENGTH        2048

Tous les identifiants doivent être exprimés en anglais, sans faute d'orthographe.

Casse

Les noms de variables, de fonctions et de fichiers doivent être écrits en minuscule, et ne peuvent contenir que des lettres, des chiffres et le caractère _.

Les noms de macros sont écrits entièrement en majuscules.

Les arguments de macros prennent une majuscule en début, comme ceci : 
#define XFREE(Var)      \
  do                    \
  {                     \
    if (Var)            \
      free(Var);        \
  }                     \
  while (0)

Types

Le nom d'une structure doit commencer par s_, celui d'un "typedef" par t_, u_ pour une union et e_ pour une énumération : 
typedef unsigned char           t_cmap[COLOR_WIDTH * NCOLORS];
typedef unsigned char           t_pixel;

struct                          s_picture
{
  int                           width;
  int                           height;
  t_cmap                        cmap;
  t_pixel                       *picture;
};

typedef struct s_picture        t_picture;

Les noms de variables globales doivent commencer par gl_.