Cómo poner comentarios en javascript

Poner comentarios entre las líneas de código, javascript o de cualquier otro lenguaje, es muy útil. Indispensable para documentar el código. Por ejemplo, nos puede servir para recordar por qué hemos hecho algo de un modo y no de otro o que tipos de datos acepta una determinada función.

Si te tomas tu tiempo para escribir los comentarios correctos nunca más mirarás el código de un viejo archivo con cara de «eh?!!? ¿Qué hacía esto?», sino con cara de «Aha! Aquí está lo que buscaba!».

Además, también se pueden comentar líneas y bloques de código para que no se ejecute pero sin eliminarlo, algo habitual durante el trabajo de desarrollo.

Comentarios JavaScript de una línea

Pon dos barras // al comienzo de la línea o justo delante del código a comentar. Todo lo que haya a la derecha de las dos barras será ignorado hasta la siguiente línea. Ideal para pequeñas notas.

Ejemplo

<script>
  // Este un comentario de una única línea
  alert("Escibiendo comentarios en javascript!"); //Aquí puedo poner una nota de lo que hace esta línea
  // alert("Esto no se ejecuta");
</script>

Comentarios multi-línea

Los comentarios de una línea pueden quedarse cortos en muchas situaciones. Puedes ir colocando // en varias líneas pero hay una opción mucho más sencilla: pon /* al principio y */ al final del comentario, puedes abarcar cuantas líneas quieras.

Ejemplo

<script>
    alert("Escribiendo comentarios multi-línea en javascript");
    /*
    alert("Esto no se ejecuta");
    alert("Esto no se ejecuta");
    alert("Esto no se ejecuta");
    alert("Esto no se ejecuta");
    alert("Y esto tampoco");
    Y este texto puede decir lo que yo quiera
    para acordarme de algo
    */
</script>

Hay una costumbre bastante extendida que consiste en añadir * (asterístico) en cada línea del bloque comentado para mejorar la lectura e identificación del bloque comentado:

<script>
    /*
    * Y este texto puede decir lo que yo quiera
    * para acordarme de algo
    */
</script>

Pero en realidad el asterístico no hace nada ahí desde un punto de vista de programación y podría ser sustituido por cualquier otro carácter con el mismo propósito:

<script>
    /*
    # Y este texto puede decir lo que yo quiera
    # para acordarme de algo
    */
</script>

Algunas consideraciones

A la hora de escribir comentarios no te olvides que pueden ser leídos por tí o por otro programador del equipo o que se haga cargo del proyecto en el futuro, así que haz comentarios claros y concisos que puedan ser de utilidad cualquier desarrollador, no sólo a tí.

Además, recuerda que JavaScript se envía a los navegadores, así que el código es público. Tenlo en cuenta, puede que quieras mantener los comentarios sólo en los archivos de desarrollo y no en los archivos finales.