ConstructiCat Logo
CodeBust.
Browse section ▾

Commentaires.

Une méthode est truffée de commentaires explicatifs.

##Signs and Symptoms

Une méthode est truffée de commentaires explicatifs.

##Reasons for the Problem

Les commentaires sont généralement créés avec les meilleures intentions, lorsque l'auteur se rend compte que son code n'est pas intuitif ni évident. Dans ce cas, les commentaires sont comme un déodorant qui masque l'odeur d'un code douteux qui pourrait être amélioré.

Le meilleur commentaire est un bon nom de méthode ou de classe.

Si vous estimez qu'un fragment de code ne peut pas être compris sans commentaires, essayez de modifier la structure du code de manière à rendre les commentaires inutiles.

##Payoff

  • Le code devient plus intuitif et évident.