Lutter contre les mauvaises odeurs

Généralement, on dit aux étudiants débutants en informatique qu’il faut commenter son code, car il est également destiné à être lu par d’autres personnes avec lesquelles on travaille. Je n’étais pas forcement convaincu par cela, car c’est toujours difficile d’expliquer ce qu’est un bon commentaire. Généralement, les étudiants font du paraphrasage du code dans leur commentaire. Les commentaires ne sont pas forcemment très utile, si l’intention est donnée par le code lui-même. Voir ici des exemples de codes mal commentés.

Martin Fowler appellent ce genre de commentaires du déodorant car ils expliquent du code difficile à comprendre (un code qui ne sent pas bon). Le code n’est pas clair, le nom des classes, des méthodes sont mal choisis, … Le commentaire tente d’apporter une solution. Le code aurait du être refactorisé pour être lisible sans commentaires.

Attention, comme il est expliqué ici, les commentaires sont néanmoins utiles, par exemple pour donner la référence d’un algorithme ou bien encore pour le décrire si l’algorithme est original.

WordPress database error: [Table 'doesnotunderstand.wp_comments' doesn't exist]
SELECT * FROM wp_comments WHERE comment_post_ID = '13' AND comment_approved = '1' ORDER BY comment_date


Subscribe

Subscribe to my RSS Feeds