Mitos acerca de los comentarios en los programas

Ya hacía tiempo que no veía un artículo de estos: los comentarios en el código son imprescindibles en algunos casos, en otros son cuestionables y en algunos casos pueden llegar a ser una molestia innecesaria. Jason Baker hable del tema en Myths about code comments que vi referenciado en Myths About Code Comments, cuyo resumen dice:

1) Comments are free (‘When you update the code that the comment references, you usually have to update the comment as well’).
2) Comments make code more readable (‘by far the most pervasive myth that I’ve encountered’).
3) You should comment every function, method, class, and module (‘documenting something that needs no documentation is universally a bad idea’).
4) Code must always be ‘self documenting’ (‘would you rather use a one-liner that requires a 3-line comment, or a 10-liner that
requires no comments?’).”

4 pensamientos en “Mitos acerca de los comentarios en los programas

  1. Pingback: Tweets that mention Mitos acerca de los comentarios en los programas « Mbpfernand0's Blog -- Topsy.com

  2. De hecho, lo que más he echado en falta en los programas de software libre no son los comentarios en el código, sino documentación sobre la visión global: cuáles son los principios básicos de programación, el flujo de ejecución, etc. Los comentarios en las funciones también sirven, vaya, pero no para comprender un programa.

  3. Pingback: Bitacoras.com

  4. Holap:

    Como todo en la vida, los extremos suelen ser malos… por lo mismo, creo que está bien comentar sin caer en excesos como los mencionados en el post…

    Saludooos :P

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s