App Cast
Publié le - 912 clics -

En programmation, des variables bien nommées valent mieux qu'un bon commentaire

Les commentaires sont sensés clarifier le code conçu par un développeur et constituer des repères lui facilitant les tâches de maintenance. Si un grand nombre de développeurs, s’accorde sur ce point, nombreux sont également ceux qui en possèdent une opinion tout à fait différente.

Explication et démonstration

Selon un chef de projet digital, les commentaires seraient tout à l’opposé de ce que la croyance générale avance. Référons-nous à l’expérience d’un développeur, ancien adepte des commentaires. En commentant consciencieusement tous ces codes, ce dernier croyait qu’il était l’exemple même du développeur modèle jusqu’à ce qu’il fit quelques découvertes qui ont radicalement transformé son point de vue. La lecture des fameux livreS « Complete Code » écrit par Steve McConnel et celui titré « Clean Code » écrit par Robert C. Martin ont fini par le convaincre du fait que les commentaires étaient tout à l’opposé de ce qu’il pensait. C’est aussi en dévorant page par page ce livre qu’il finit par se rendre compte des raisons qui l’ont poussé à commenter tous ses codes. En effet, l’utilité des commentaires ne se pose que lorsque les codes utilisés ne sont pas correctement nommés. L’autre raison imposant l’utilisation des commentaires, est le fait que les fonctions et les méthodes usitées ne possèdent pas la précision indispensable. Ce qui fait qu’un développeur commentant ses codes, est en général un professionnel qui ne sait pas montrer ses desseins.

Témoignage d’un développeur ancien adepte des commentaires

Ce chef de projet digital croyait bien faire en commentant ces codes afin d’en assurer la compréhension au prochain développeur qui les utilisera. Cependant, en concevant des codes d’une plus grande clarté, il s’est rendu compte que les commentaires sont inutiles. Ecrire des codes mieux situés et définis, suffit donc, pour que les autres développeurs réussissent à comprendre des codes sans pourtant avoir à se surcharger en commentaires en définitive, inutiles. L’une des parades qu’il a dénichées dans ses lectures, est de concevoir des codes possédant des variables bien nommés. Il a d’ailleurs, appliqué ses constatations en éditant un véritable code sans commentaire, mais avec des variables bien nommées. Il s’est avéré que le résultat était plus que clair.