Comentarios en programación

Comentarios en el código

– ¿Publicas tu código en Facebook?
– Por supuesto. ¿No me dijiste que mi código necesitaba más comentarios?

En el día a día de todo programador, uno tiene que enfrentar-se a código desarrollado por terceros. Esto, en ocasiones, puede ser tan apasionante como entrar en la mente de otra persona… o al menos, intentarlo. Afortunadamente, están los comentarios, esas anotaciones que describen y complementan el código para ayudar a su compresnsión, incluso para su propio autor. Si se siguen una serie de buenas prácticas para la documentación del código, el enfrentarse a un código ajeno (o a algo hecho por nosotros hace mucho tiempo) resulta mucho menos frustante.

Pero, a veces, los propios comentarios pueden inducir a la confusión. Ya sea de forma accidental (si se han escrito rápido, sin pensar en quien los puede leer en el futuro) o de forma motivada (un programador con mala baba, o simplemente un cachondo). En cualquier caso, al encontrar este tipo de comentarios, en ocasiones, es dificil no dejar escapar una sonrisa (aunque sea por no llorar).

Por ejemplo:

//When I wrote this, only God and I understood what I was doing
//Now, God only knows

En el siguiente enlace han hecho un divertido recopilatorio de comentarios encontrados en el código. Algunos son para troncharse (en inglés):