Comentarios en el código

Los comentarios no tienen que explicar lo que hace el código, tienen que aclarar el porqué se ha escrito así ese código.

Con un código limpio, con nombres de clases, variables etc… claros y concisos, esto hace que el código esté auto-documentado. No hay necesidad de añadir comentarios. Si el código es complejo, reescribe lo, no lo comentes.

Los comentarios quedan obsoletos con el tiempo, cuidado que pueden ser un arma de doble filo.

Para legacy code, es más interesante comentar lo que hemos averiguado sobre su funcionamiento antes de refactorizarlo. Si estás trabajando sobre una parte de código que sigue en funcionamiento, es interesante poner algún comentario que indique que estamos refactorizando esa parte de código.

También puede ser interesante comentar algunos requisitos no funcionales para quien pueda verlo entienda las limitaciones del sistema, por ejemplo el orden de algunas lineas que es necesario para cierto funcionamiento, limitaciones en alguna función que pueda hacer que se llene el disco si se ejecuta, etc…

Fuente: Podcast Ni cero, ni uno