1
Conventions de codage.
1. Introduction.
La notion de conventions de codage (coding style) désigne un ensemble de règles et de conseils adoptés par les programmeurs.
Il existe une ou plusieurs normes de programmations spécifiques, définies par des standards ISO. En C par exemple, il existe la norme ANSI C ou la norme C99.
1. Limiter la taille du code :
a. entre 50 et 100 lignes code pour une fonction, b. moins de 1000 ligne pour un fichier .c
2. Indentation du code,
3. Nombre de caractères par ligne,
4. Conventions de nommage : choix des noms des identificateurs : variables, constantes, types, fonctions, paramètres,
2. Noms des identificateurs.
Types définis à l’aide de typedef :
- Débuter le nom du type par t_ typedef t_Eleve
Variables :
- Commence toujours par une lettre minuscule suivie d’une majuscule : o int iAge ;
o float fSalaire ; o t_eleve t_E1 ;
o int *p_entier ; /* pointeur d’entier */
o etc ..
Variables aux noms composés :
- Commence le 1er mot par une lettre minuscule et les mots suivants débutent par une majuscule :
o int iJourDeNaissance ;
Constantes (#define) : toujours en majuscules #define MAXIMUM 999
Structure (struct) : Les modèles de structures commencent par une majuscule.
struct Date {
int iJour;
int iMois;
int iAnnee;
};
Exemple : struct Date d1 ; typedef Date t_Date ; t_Date d1 ;
2
3. FONCTIONS
Noms de fonctions| :
- Commence le 1er mot par une lettre minuscule et les mots suivants débutent par une majuscule, le nom de la fonction contient un verbe à l’infinitif décrivant la fonction
o int calculerSommeDesProduits() ; o void afficherLaListeDesEleves()
Paramètres et variables locales de fonctions| :
- Le nom d’un paramètres commence par la lettre minuscule p ( comme paramètre) - Le nom d’une variable locale commence par la lettre minuscule l (comme locale).
Ex : int somme ( int pX, int pY) {
int lResultat =0 ; lResultat = pX + pY ; return pResultat ; }
Autres cas :
Variables globales
Les noms des variables globales commencent par g : int gCompteCourant ;
float gMoyenne ;
/* variables non déclarées dans aucune fonction, même pas dans le main */
Variables externes
Les noms des variables externes commencent par x :
int xCompteGen ; /* variables déclarée dans un autre fichier .c */
Variables d’itérations
Les noms de variables des boucles (for, while, do while() ;) : i, j, k, ….
Suppression de code obsolète
Ne pas garder le code obsolète (en le mettant en commentaire).
