La place du commentaire dans son code

Par | 2017-10-20T11:11:24+00:00 20 octobre 2017|Web / développement|

Tous les langages de programmation possèdent des marqueurs qui permettent à des portions du code source d’être ignorées par le compilateur ou l’interpréteur. Ces bouts de programme sont en général destinés à un lecteur humain afin de donner des explications sur les lignes de code qui suivent. Plus pragmatiquement, les commentaires permettent également aux développeurs de shunter une partie du code, dans les phases de debugging.

On nous apprend toujours à commenter son code afin d’informer toutes personnes qui récupéreraient vos sources. Bien entendu, commenter la moindre affectation de variable ou une simple fonction alourdirait la page de code et augmenterait sensiblement le temps de développement.

En fait, le commentaire ne doit intervenir que si le code n’est pas assez explicite par lui-même. Dori Reuveni et Kevin Bourrillion propose plusieurs solutions dans un article : Code Health: To Comment or Not to Comment? sur Google Testing Blog pour éviter de mettre des commentaires inutiles :

Introduire une variable explicative
Extraire une méthode
Utiliser un identifiant plus explicite
Ajouter une condition explicite

Ils précisent qu’il existe certains cas où le commentaire est recommandé. Notamment, dans le cas où le commentaire vient expliquer pourquoi le code fait quelque chose à l’opposer du commentaire qui explique ce que fait le code. Ils donnent quelques exemples :

A contrario, ils expliquent des cas où les commentaires sont inutiles :