Cómo comentar el código en JavaScript de forma correcta

En esta ocasión vamos a ver cómo comentar el código en JavaScript de forma correcta. Podría decir también de forma segura. Es un asunto fácil, pero hay una consideración importante que debes tener en cuenta para no cometer errores cuando comentas fragmentos de código.

Consideraciones a tomar cuando comentas código en JavaScript

Tienes que tener en cuenta que los comentarios son algo muy útil para facilitar la lectura de tu código y su mantenimiento, pero deben estar siempre actualizados. Probablemente no haya nada peor que comentarios desactualizados de cara a empeorar la mantenibilidad y legibilidad de tu código. Esto es algo que debes tener siempre presente ya que la mayor parte del tiempo estamos leyendo código.

Tipos de comentarios en JavaScript

En JavaScript tenemos dos tipos, o formas, de comentarios. El comentario de línea (representado por //) y el comentario de bloque (representado por /* … */ )

Ejemplo de comentario de línea:

function sumar(a, b) {
     // Devolvemos la suma de a + b. Por cierto, esto es un comentario de línea :)
     return a+b;
}

Ejemplo de comentario de bloque:

/*
     Esta función devuelve la suma de a + b
     En este momento no se considera que a y b no sean numéricos
*/
function sumar(a, b) {
     // Devolvemos la suma de a + b. Por cierto, esto es un comentario de línea :)
     return a+b;
}

Cómo comentar el código en JavaScript

Partimos de la base de que podemos usar indistintamente un tipo de comentario u otro. Usaremos, por norma general, el comentario de línea para comentar una sola línea y el comentario de bloque para comentar dos o más líneas. Pero aquí, tenemos que tener una consideración muy importante. Para comentar bloques de código usaremos siempre comentarios de línea. Te voy a mostrar porqué con un sencillo ejemplo:

function saludo(nombre) {
     return 'Hola ' + /* Aquí pondre el nombre */ nombre;
}

La función anterior es correcta sintacticamente. No hay ningún error semántico. Si hay una muy mala práctica que es poner poner comentarios de bloque entre el código. Ahora si nosotros comentamos la función completa con un comentario de bloque de la siguiente forma:

/*
function saludo(nombre) {
     return 'Hola ' + /* Aquí pondre el nombre */ nombre;
}
*/

Dará un error ya que el comentario terminará en el cierre del comentario de bloque de la línea return, dejando lo que resta de línea (‘ nombre;’), la llave de cierre de la función y cierre de comentario de bloque final como código que obviamnte no «compilará». Tendremos un error de sintaxis.

Por este motivo, una buena práctica es:

• Usa comentarios de línea cuando desees comentar una sola línea
• Usa comentarios de bloque cuando desees comentar varias líneas
• Excepción: Aún cuando quieras comentar varias líneas, si son líneas de código, usa siempre comentarios de línea.

Conclusiones

Comentar el código es algo sencillo y práctico. Nos puede ayudar a hacer más legible y mantenible nuestro código ( o todo lo contrario por lo que ya hemos hablado). Pero también podemos ver que algo tan sencillo puede ocasionarnos problemas tanto de legibilidad y mantenimiento, como de sintaxis.

Ya sabes cómo comentar el código en JavaScript de forma correcta. Puedes aprender más en nuestra sección de Desarrollo Web o en la sección específica de JavaScript.

¡Espero que te haya sido de utilidad!