Comentarios

Los comentarios son el ultimo recurso para añadir claridad a nuestro codigo, ya que un buen codigo deberia ser autoexplicativo. Sin embargo, hay situaciones en las que un comentario es necesario para aclarar algo que no es obvio.

No seas redundante

De nada sirve comentar un codigo que sea autoexplicativo, ya que solo añade ruido y dificulta la lectura.

Evita la obviedad

No se debe añadir comentario de obviedades del codigo.

Explica el por qué, no el qué

Los comentarios deben explicar el por qué se hace algo, no el qué se hace. El qué deberia ser obvio a traves del codigo. Esto ademas ayuda con futuras refactorizaciones, ya que una estas pueden cambiar el qué, pero el por qué deberia seguir siendo el mismo.

Manten los comentarios actualizados

Los comentarios desactualizados son peores que no tener comentarios. Si un comentario no refleja el codigo, es mejor eliminarlo.

Esta es la razon principal por la cual se debe disminuir el numero de comentarios, ya que estos deben ser mantenidos y actualizados en conjunto con el codigo, añadiendo asi otra dependencia a nuestros repositorios.

No comentes codigo, eliminalo

Si un codigo no es necesario, no lo comentes, eliminalo. Los comentarios temporales son una mala practica, ya que se olvidan y se acumulan, dificultando la lectura del codigo.

No dejes comentarios temporales en produccion

Los comentarios temporales son por lo generaL una mala practica, pero si se dejan en produccion, pueden ser un riesgo de seguridad, ya que pueden contener informacion sensible.

Siempre puedes tener comentarios temporales en tu entorno local, como recordatorios o To-Do’s.

No comentes codigo que no entiendes

Si no entiendes el codigo, no lo comentes, estudialo y entiendelo. Si no puedes entenderlo, es probable que otros tampoco puedan, por lo que se deberia refactorizar.