Qualité de codage
Qualité de codage Constantes Variables Commentaires Indentation En tête de fichier
Qualité de codage Constantes Un nom illustrant de façon parlante ce que représente la constante En MAJUSCULE En début de fichier main ou header. Variables Commentaires Indentation En tête de fichier
Qualité de codage Constantes Variables Un nom illustrant de façon parlante ce que représente la variable En début du main et des fonctions En minuscule Si le nom est "composé", la première lettre de chaque mot sera en majuscule Exemple : tauxDeCroissancePopulation1 Commentaires Indentation En tête de fichier
Qualité de codage Constantes Variables Commentaires Fonctionnel plutôt que technique. Ils décrivent la fonctionnalité du code qui suit. Devant les boucles et structures conditionnelles Devant les déclarations de fonctions Indentation En tête de fichier
Qualité de codage Constantes Variables Commentaires Fonctionnel plutôt que technique. Ils décrivent la fonctionnalité du code qui suit. Indentation En tête de fichier Exemple de mauvais commentaire : // pour i allant de 0 à la durée de l'emprunt, faire le calcul sommeTotal = sommeInitial for(i=0;i<duree;i++) { sommeTotal = sommeTotal*(1+taux) ; } cout = sommeTotal - sommeInitial
Qualité de codage Constantes Variables Commentaires Fonctionnel plutôt que technique. Ils décrivent la fonctionnalité du code qui suit. Indentation En tête de fichier Exemple de commentaire plus judicieux // calcul du coût de l'emprunt sommeTotal = sommeInitial for(i=0;i<duree;i++) { sommeTotal = sommeTotal*(1+taux) ; } cout = sommeTotal - sommeInitial
Qualité de codage Constantes Variables Commentaires Indentation Chaque bloc d'action doit être facilement identifiable. Un retrait après chaque { En tête de fichier
Qualité de codage Constantes Variables Commentaires Indentation En tête de fichier Le fichier du programme principal doit comporter un en-tête donnant la description de ce que fait ce dernier. Les fichiers headers (.h) et sources (.c) doivent comporter un en- tête rappelant le nom de fichier, l'auteur, etc