Règles d'écriture
Avant de commencer à créer des programmes et leurs fonctions, voici quelques règles à respecter :
un fichier par catégories ou types de fonctions (par exemple, les fonctions destinées à gérer un clavier),
nommage du fichier = nom de la catégorie. Par exemple
clavier.cetclavier.h. Cela permet de s'y retrouver plus facilement et également de réutiliser les classes dans d'autres programmes.respecter les conventions de nommage : voir ce lien par exemple et ce qui suit.
Remarque : Pourquoi respecter ces règles ?
Il est toujours possible de ne pas respecter ces règles, car elles n'influent pas sur le fonctionnement des programmes : ceci étant dit, en les respectant, on améliore la lisibilité du code source et, ce faisant, on diminue le risque d'erreurs et on facilite la maintenance ainsi que le travail en équipe et la réutilisabilité du code.
Méthode : Nommage des variables et fonctions
la première lettre doit toujours être en minuscule,
on peut utiliser un mélange de minuscules et de majuscules avec, cependant, la première lettre de chaque mot en majuscule[1],
il est recommandé d'utiliser des noms simples et descriptifs,
ne pas commencer les noms avec '$' ou '_' (bien que ce soit possible),
il est possible d'utiliser des noms de variable d'une seule lettre (pour un usage local, comme à l'intérieur d'une boucle par exemple)
d'une manière générale : n'utiliser que les lettres [a-z] et [A-Z] et les chiffres [0-9] et ne pas utiliser de tiret '-', d'underscore '_', ou d'autres caractères ($, *, accents, ...).
Méthode : Nommage des constantes
tout en majuscule
on peut séparer les mots par underscore '_'
il est recommandé d'utiliser des noms simples et descriptifs,
d'une manière générale : n'utiliser que les lettres [A-Z], les chiffres [0-9] et underscore '_', et ne pas utiliser de tiret '-', ou d'autres caractères ($, *, accents, ...).
Fondamental : Commentaires
Une dernière règle, peut-être la plus importante : les commentaires ! Ils sont utiles pour expliquer le code que l'on a écrit ou pour comprendre le code que quelqu'un d'autre a écrit... Voici quelques règles pour un bon commentaire [2]:
faciliter la lecture du code,
apporter une indication sur un choix de conception, sur le fonctionnement d'un algorithme,
donner un exemple pour permettre de mieux comprendre ce que fait le code.
Un mauvais commentaire pourrait être :
un commentaire qui décrit un morceau de code qui n'existe plus,
un commentaire qui explique une évidence :
/*Additionne a et b et stocke le résultat dans c*/c = a + b;