Mammouth du PHP |
19672 Messages
10 juil. 2007, 19:38
Pour ce qui est de commenter le code, c'est important pour deux raisons.
La première, c'est que, même pour celui qui développe le code, il doit pouvoir le reprendre dans six mois ou dans deux ans sans passer une semaine dessus pour comprendre ce qu'il doit effectuer.
La seconde, c'est lorsqu'on travaille en équipe : les coéquipiers doivent pouvoir rentrer dans le code des autres pour les mêmes motifs que précédemment. Et ce point là, je le vis au quotidien, il faut parfois se bagarrer pour obtenir que certains collègues se disciplinent un peu.
Enfin, je dirais que, partant du principe que les cimetières sont remplis de gens irremplaçables, il n'est pas exclus que chacun d'entre nous soit appelé vers d'autres cieux (ou une autre activité) à un moment ou un autre : il est donc souhaitable de laisser un terrain propre pour ceux qui prendront le relai. On le réalise d'autant plus lorsqu'on prends soi-même le relai derrière un autre.
Mais c'est une habitude. Parfois difficile à adopter au départ, mais on finit par le faire naturellement sans soucis. Et ce sera d'autant plus facile si on le fait au fur et à mesure, pas après avoir écrit 5000 lignes de code.
Codez en pensant que celui qui maintiendra votre code est un psychopathe qui connait votre adresse 