Las cookies nos permiten ofrecer nuestros servicios. Al utilizar nuestros servicios, aceptas el uso que hacemos de las cookies. Más Información. Aceptar

Comentarios en el código: sí o no- Refactoring & Clean Code

César Díaz Alcolea
Comentarios en el código: sí o no- Refactoring & Clean Code
El reproductor de video será cargado en breves instantes.

Comentarios dentro del código, ¿sí o no?

Según mi experiencia, cuándo se utilizan comentarios en el código suelen ser poco fiables, y debemos confiar solo en el código.

Hay una frase muy relacionada con esto, que dice:

“El código nunca miente, los comentarios sí.” — Ron Jeffries

Imagen 0 en Comentarios en el código: sí o no- Refactoring & Clean Code

Los comentarios requieren mantenimiento, y muchas veces se empieza a meter comentarios, pero el día de mañana se dejan de mantener, con lo cual el comentario dice una cosa y el código hace otra.

Tipos de comentarios a evitar

  • Evitar marcadores posicionales

Imagen 1 en Comentarios en el código: sí o no- Refactoring & Clean Code

Estos comentarios simplemente añaden ruido, no añaden nada, son comentarios inútiles.

  • No dejar el código comentado en su código base

Imagen 2 en Comentarios en el código: sí o no- Refactoring & Clean Code

Encontrar código que está comentado y que ya no se utiliza, hoy en día no tiene sentido, ya que tenemos el control de versiones, tenemos Git y tenemos un historial de versiones, en el cual podemos buscar el código que teníamos anteriormente.

Dejar trozos de código comentado lo único que hace es añadir ruido y añadir tiempo de lectura a la hora de revisar nuestro código.

  • No dejar comentarios de diario

Imagen 3 en Comentarios en el código: sí o no- Refactoring & Clean Code

Otro tipo de comentarios que hoy en día, teniendo Git, no tienen ningún sentido, ya que acaban siendo una lista de comentarios.

Además, puede llegar el momento en que dejen de añadirse nuevas líneas, y no va a estar en consonancia lo que indica el comentario y lo que dice el código, por lo que al final debemos fiarnos solo del código y hay que tener el código limpio.

Comentarios aceptables

“El uso adecuado de los comentarios es compensar nuestra incapacidad para expresarnos mediante el código” — Robert C. Martin

Existen algunos tipos de comentarios que se pueden considerar medios aceptables, y son los comentarios que tienen complejidad lógica de negocios. En estos casos, los comentarios son una disculpa y no un requisito.

Un buen código vas a ser siempre autodocumentado . Si un comentario te explica lo que el código está haciendo, probablemente sea un comentario inútil, y seguramente, si se retoca un poco el código y se usan buenos nombres para las funciones y variables, probablemente se pueda eliminar ese comentario.

Hay cosas que pueden ser interesantes de comentar, porque sea algo un poco más abstracto, como podría ser por ejemplo comprobar una expresión regular, ya que se puede leer la expresión regular y quizás no se sepa qué es lo que está comprobando.

Puede ser también el caso del uso de un algoritmo de encriptación en vez de otro, o que alguna cosa tenga una dependencia de un tercero y se tenga que hacer una espera, entonces poner ahí ese tipo de comentario que aporta algún valor, podría ser medio aceptable.

Recibe los últimos artículos de Programación y Sistemas

Suscríbete a la newsletter y recibe además un pack de bienvenida con nuestros mejores recursos.


En OpenWebinars trataremos tus datos para personalizar el servicio ofrecido, notificarte comunicaciones internas, noticias y ofertas de nuestros servicios, así como realizar analíticas de tráfico y datos de uso. Puedes revocar el consentimiento, ejercer tus derechos de acceso, rectificación, cancelación, oposición, limitación del tratamiento, portabilidad y supresión escribiéndonos a administracion@openwebinars.net.

Más información en la Politica de Privacidad

Relacionado

Te dejamos una selección de cursos, carreras y artículos

Qué es Refactoring y cómo hacerlo paso a paso

Qué es Refactoring y cómo hacerlo paso a paso

Metodologías y herramientas

05 de Diciembre de 2019

Si quieres saber en qué consiste el refactoring o proceso de refactorización, te lo contamos en este artículo, en el que además te explicamos cómo realizar este proceso de una forma adecuada.

Programador full stack MEAN

Programador full stack MEAN

carrera

Incluye 8 cursos:

  • Curso Online de MongoDB
  • Curso de Angular 4
  • Curso de JavaScript Profesional

y 5 cursos más!

Duración: 43 horas y 33 minutos

Curso de técnicas de Refactoring y Clean Code

curso

Curso de técnicas de Refactoring y Clean Code

curso

Con este curso aprenderás:

  • Aprenderás que es Refactoring.
  • Conocerás el concepto de código limpio y su importancia.
  • Conocerás cuando y como hacer Refactoring.

Duración: 5 horas y 40 minutos

Estas son algunas de las empresas que ya confían en OpenWebinars

Profesores y profesionales

Nuestros docentes son profesionales que trabajan día a día en la materia que imparten

Conviértete en profesor de OpenWebinars