Desarrollo de software. Comentarios

Si el código es complicado de entender es mejor invertir esfuerzo en hacerlo inteligible (refactorizar) que en hacer comentarios que generalmente ayudarán poco al que lo lee y que después tocará probablemente mantener cuando se toque esa sección del código.

No se trata de prohibir los comentarios sino de elegir muy bien dónde se ponen y por qué se ponen.

¿Cuántas veces nos encontramos con comentarios que describen en lenguaje natural lo que hace el código?, ¿es eso útil?, ¿no sería más útil explicar por qué se ha elegido esa solución que describirla paso a paso?, ¿es necesario explicar siempre por qué?.

Si no se sigue una política adecuada en los comentarios es más probable que perjudiquen mucho más que sirvan de ayuda, no solo ya porque afecten a la legibilidad del código, no solo porque sea necesario mantenerlos sino porque además pueden dar pistas falsas al desarrollador en el caso precisamente de que no se hayan mantenido y ya no sean congruentes con el código o bien en el caso de que su contenido no sea correcto.

Anuncios
4 comentarios
  1. francisco dijo:

    Nada habla más claro que el código bien escrito

    • jummp dijo:

      Totalmente de acuerdo.

  2. Los comentarios son muy utiles cuando explican lo no obvio.
    Lo que mas me fascina de tu blog es el ANONIMATO 🙂
    Gracias anonimo sabio
    (se poner acentos pero mi tableta no)

    • jummp dijo:

      Muchas gracias por tu comentario. Aunque indicase en el blog mi nombre y apellidos seguiría siendo una persona anónima ya que soy un empleado más con un puesto intermedio (más bien tirando para abajo) dentro de una organización con muchísimos empleados.

      Tarde o temprano terminaré publicando quién soy y dónde trabajo.

      De todas formas lo que da sentido a un blog no es quien lo escribe sino quiénes lo leen y sin duda, el talento de mis lectores, supera con creces el que pueda tener yo.

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

A %d blogueros les gusta esto: