Refactorizando código. Comentarios.

“No comente el código incorrecto, reescríbalo”, esto decían Brian W.Kernighan y P.J.Plaugher, y es que no hay nada más provechoso y rentable que un comentario bien puesto…y nada más peligroso que un comentario innecesario, erróneo o anticuado.

Rober C. Martin indica que “los comentarios siempre son fallos…los comentarios mienten, no siempre y no siempre intencionadamente, pero lo hacen. Cuando más antiguo es un comentario y más se aleja del código que describe, mayor es la probabilidad de que se equivocado. Los programadores no los pueden mantener”.

La verdad solo se encuentra en un lugar y ese es el código fuente.

Síntomas de código erróneo debido a los comentarios

• Información inadecuada: Los comentarios informativos debieran ir en un sistema como un control de código fuente por ejemplo. Es un error llenar un fichero de código fuente con líneas de historiales de cambios. Los comentarios deben servir para comentar notas técnicas sobre código o diseño.
• Comentarios obsoletos: Referido a comentarios antiguos o incorrectos. Se recomienda no escribir un comentarios que se intuya no vaya a ser actualizado.
• Código comentado: Es muy típico encontrarse con bloques de código comentado, que siguen ahí mucho tiempo porque nadie se atreve a borrarlos ya que nadie sabe realmente si son útiles o no. El código comentado es una perdición para programadores futuros. La única solución para resolver este problema es eliminar el código comentad.
• Comentario redundante: El típico comentario i++; // incrementar i describe algo que ya se define por si solo.