Règles d'écriture
Afin de garantir la lisibilité d'un programme, il est important
de se fixer quelques règles.
Certaines de ces règles sont incontournables, d'autres sont des
choix qu'il faudra respecter un fois faits.
Il est important de bien formater
son programme par des passages à la ligne adéquats :
- une déclaration commence et termine sa ligne ;
- une instruction élémentaire commence et termine sa
ligne ;
- une structure de contrôle (if, for ...) commence sa ligne. Le else if est
considéré comme une seule structure de contrôle ;
- une accolade ouvrante termine sa ligne. Deux styles sont
possibles : soit elle est toujours seule sur sa ligne, soit elle est
sur la même ligne que la structure de contrôle
correspondante.
- une accolade fermante est seule sur sa ligne ;
- une étiquette est seule sur sa ligne.
Le programme doit être correctement
indenté. Pour cela, il suffit d'utiliser les commandes
d'indentation d'emacs (tab
à chaque changement de ligne ou ^-x indent-region sur un groupe
de lignes par exemple) si le programme a été correctement
découpé au préalable.
Les identificateurs doivent utiliser une seule langue.
Ils doivent avoir des noms significatifs ou usuels (i pour un compteur de boucle
par exemple).
Un seul style doit être utilisé pour le découpage
des mots à l'intérieur d'un identificateur. En C, on
écrit souvent les identificateurs tout en minuscule en
séparant les mots par des soulignés :
int nombre_de_voitures;
Seulles les pseudo-constantes et les pseudo-fonctions, crées
à l'aide des directives #define,
sont écrites tout en majuscule.
#define PI 3.1416
#define CARRE(x) ((x) * (x))
Les commentaires doivent le plus possible être regroupés.
Ils ne sont pas là pour compenser un code mal écrit !