septembre
2010
Un article de rad_hass
Voilà un titre à bien des égards trollesque, je me souviens il y a quelque temps d’un débat dans le forum développez autour du commentaire et ce n’était pas de tout repos, mais au delà d’être pour ou contre le commentaire, certains ne trompent pas, ils sont bien là pour masquer les mauvaises odeurs. Voilà ici une figure de style que j’affectionne particulièrement, elle n’est pas de moi alors il faut rendre à césar ce qu’est à césar :
Dont’s worry, we aren’t saying that people shouldn’t write comments. In our olfactory analogy, comments aren’t a bad smell; indeed they are a sweet smell. the reason we mention comments here is that comments often are used as a deodorant. It’s suprising how often you look at thickly commented code and notice that the comments are the because the code is bad.
Comments lead us to bad code that has all the rotten whiff’s we’ve discussed in the rest of this chapter. Our first action is to remove bad smells by refactoring. Wehn we’re finished, we often find that the comments are superfluous.
If you need a comment to explain what a block of code does, try extract method. If the method is already extracted but you still need a comment to explain what it does, use rename method. if you need to state some rules about the required state of system, use introduce assertion.
When you feel the need to write a comment, first try to refactor the code so that any comment becomes superfluous.
A good time to use a comment is when you don’t know what to do. In addition to describing what is going on, comments can indicate areas in which you aren’t sure. A comment is a good place to say why you did something. This kind of information helps future modifiers, especially forgetful ones.
Extrait de « Refactoring: improving the design of existing code »
L’idée est que certains commentaires sont utilisés comme du déodorant pour masquer les mauvaises odeurs, alors avant de commenter voyez si votre code ne peut pas être amélioré, Refactoring Inside. Un commentaire superflue, nuit plus qu’il ne contribue, alors essayer d’extraire le code à commenter, si c’est déjà fait renommer la méthode pour rendre plus explicite ce qu’elle fait…
Commentaires récents
- dans [Scrum] Générer un Burdown chart de Sprint
- dans [Scrum] Générer un Burdown chart de Sprint
- dans Les stars de l’actualité informatique : Cloud et Agilité …
- dans Les stars de l’actualité informatique : Cloud et Agilité …
- dans Organiser sa journée de travail ? Efficacité et productivité sans stress c’est possible