Le code et les commentaires 4
Je viens de lire la traduction d’un article parlant des commantaires dans le code source sur le Framablog . C’est un article écrit par Esther Schindler que je ne connais pas. Son article original titré If the comments are ugly, the code is ugly parle donc de code source, de code source avec de vilain commentaires.
Elle signale que les commentaires doivent être irréprochable, sans faute d’orthographe, sans erreur de grammaire, à jour par rapport aux codes sources commenté…
Et bien j’ai trouvé une solution encore plus simple: je supprime les commentaires et j’essaie de rendre le code plus lisible. Les langages de programmations actuel sont assez expressif, utilise des mots anglais clair, certain langage apporte une structure permettant même d’écrire des presques phrases ! Un code propre n’est pas un code avec des commentaires à jour, mais un code lisible, clair et concis
De plus, tout les langages modernes (enfin j’espère) bénéficie d’une librairie de test unitaire, ce qui veut dire que l’on peut écrire un bout de code très simple qui montre l’intention du programme réel, qui montre comment il fonctionne, qui le documente en quelque sorte. Alors pourquoi écrire en plus des commentaires ? Je préfère voir un code lisible, et au pire devoir aller lire des tests unitaires pour comprendre son fonctionnement (voir ajouter des tests pour vérifier que j’ai bien compris).
Alors je ne sais pas qui est cette dame, mais, même si elle a en partie raison, pitié, éviter de faire du code illisible et sans test unitaire programmé sous pretexte que vous avez écrit des commentaire digne d’un grand roman.
Ah les int addition(int a, int b) // fonction addition d’entiers a et b …
Un grand moment de poilade surtout quand 10 lignes plus loin on voit un algo inhumain non commenté.
Je suis tout à fait d’accord que les tests sont la priorité. Mais bon, la documentation ensuite est toujours un plus.
En lisant ton post, on a l’impression qu’écrire des tests te dispenserait de commenter la moindre ligne de code que tu écris. Je ne crois pas que ce soit ton message, mais si c’est le cas… bof bof. :)
disons que je préfère avoir un code lisible sans commentaire (ou plutôt qui se passe de commentaire on va dire) qu’un code illisible avec un beau commentaire: ce que je manipule en tant que développeur, c’est le code, pas les commentaires :-)
Ca peut paraitre bofbof, mais je m’en sort pas trop mal pour le moment, et j’ai jamais vu un commentaire utile, ou à jour (donc en général je le supprime).