6. Bien programmer: les commentaires sont toujours redondants

Si vous avez ecrit votre code en suivant les règles précédentes, que vous l'avez de surcroît indenté (le programme indent de GNU fait un excellent travail pour les paresseux et pour ceux qui écrivent des patchs et qui veulent les indenter dans le style de l'auteur), dans ce cas, les commentaires sont inutiles.

Etant donné qu'il faut toujours éviter les commentaires triviaux, du style:

/* si x est superieur a zero */
if (x > 0)
/* alors on quitte */
 exit (0);
		

étant donné que votre code contient des noms de variables explicites et des noms de fonctions qui décrivent le travail des fonctions, votre code s'auto documente. De plus, pour faire un dernier retour sur la redondance, un commentaire trivial comme le précédent est redondant, et pose un problème si l'on modifie le code pour tester si x est seulement différent de zéro: il faudra penser à modifier le commentaire. Bref, maintenant, les seuls commentaires autorisés seront des références à des livres ou des pages web décrivant un algorithme qui est loin d'être trivial comme une methode de compression de données ou de cryptage. Un commentaire a le même rôle qu'une note de base de page dans un roman. Hors de question de commenter l'algorithme d'initialisation d'un tableau d'entiers à zéro!!!

création est mise à disposition sous un contrat Creative Commons