sábado, 15 de octubre de 2011

Comentar o no comentar... siguiendo tendencias

Me he topado varias veces con debates en torno a si añadir comentarios en el código es bueno o malo. Y aunque dudo que lo que yo pueda pensar al respecto vaya a inclinar la balanza de un lado u otro, me apetecía escribir sobre este tema.

Lo que no podemos negar es que al comentar el código se está duplicando información: por un lado está el comentario sobre el código y por otro el propio código. Esto hace que cada vez que la información a la que hacen referencia cambie se deba hacer cambios en dos puntos. Y lo que es peor, si la información cambia y (por las prisas, despistes, ...) no actualizamos tanto el código como el comentario, al final tendremos un comentario desactualizado, y más que aclarar lo que hace es confundirnos.

También deberíamos pensar por qué creemos que es necesario añadir un comentario. En The Pragmatic Programmer podemos leer "Programmers are taught to comment their code: good code has lots of comments. Unfortunately, they are never taught why code needs comments: bad code requires lots of comments." Puede que la necesidad de comentar el código refleje una carencia: no has elegido buenos nombres para los métodos/variables/clases, el código es demasiado complejo, etc.

Dicho esto, también deberíamos tener en cuenta que nadie te conoce mejor que tú mismo. Nadie conoce a tu equipo mejor de lo que lo conoces tú. Y nadie conoce tus proyectos mejor que tú. Si desde tu punto de vista añadir un comentario va a aportar más beneficios que problemas, yo creo que no debes sentir el más mínimo remordimiento por ponerlo. Te aseguro que no va a morir un angelito por ello. Al final es una cuestión de rentabilidad, si sabes los costes y los beneficios, está en tu mano, y no en la de otros, decidir. Personalmente, puedo decir que en muchas ocasiones he agradecido un buen comentario.

Al pensar en esto, y viendo algunas posturas en ciertos debates, creo que a veces sufrimos lo que yo llamo efecto peinado intelectual. ¿Te ha pasado alguna vez que el Beckham de turno se hace un peinado "diferente" y a los pocos días no haces más que ver a gente con el mismo peinado? Pues a algunos nos suele pasar algo similar en nuestra profesión. Cuando alguien de peso hace una afirmación tendemos a repetirla y asumirla sin muchos miramientos. Desde luego, hay que respetar y tener en cuenta lo que dicen los buenos profesionales, pero siempre desde un punto de vista crítico.

Al pensar en este tema, también suelo recordar un chiste que, probablemente por mi simpleza, siempre me ha hecho mucha gracia:

están dos pájaros en una rama... y le dice uno a otro, ¡pío!... a lo que el otro contesta... haz lo que te salga de los cojones.

No hay comentarios:

Publicar un comentario