Los comentarios son fragmentos de texto que el intérprete de JavaScript omite al ejecutar el programa. Sirven para documentar el código para otros programadores o para uno mismo. De hecho, añadir anotaciones es una buena práctica que facilita la lectura y el mantenimiento, sobre todo en proyectos grandes.
Otra gran utilidad de los comentarios es que permiten desactivar temporalmente partes del código que no queremos que se ejecuten. Esto puede ser útil cuando se realizan pruebas de fragmentos de código, al comparar distintas soluciones sin necesidad de tener que borrar las instrucciones originales.
En JavaScript hay dos tipos de comentarios: los que son de una sola línea y los que son de bloque. Para crear un comentario de una línea se usa dos barras inclinadas (//) al inicio del texto que se desea omitir. En cambio, los de bloque se delimitan entre /* y */, lo que permite abarcar múltiples líneas de código.
Comentarios de una línea
Los comentarios de una sola línea van precedidos de dos barras inclinadas (//), que generalmente irán situadas al principio de línea. No obstante, se pueden ubicar en cualquier punto intermedia de una línea. De este modo, la parte de código a omitir quedará ubicada a la derecha de las dos barras.
En este ejemplo, el comentario es toda la línea:
// Comentario de línea entera
En este, el comentario empieza en una posición intermedia:
let lang = "JS" // Comentario
Comentarios de múltiples líneas
Los comentarios de bloque (múltiples líneas) se delimitan entre los símbolos /* y */, lo que permite abarcar varias líneas de código. En este caso, todo el código o texto que quede dentro será ignorado por el intérprete de JavaScript. El fragmento a ignorar peude extenderse tantas líneas como sea necesario.
/* Primera línea
de un comentario
de muchas líneas. */
Comentarios dentro de <script>
En un documento HTML, dentro del elemento <script> se puede introducir los dos tipos de comentario (de línea o de bloque), tal y como se hace en archivos externos de JS. En ambos casos funcionan correctamente los dos tipos.
- Comentarios de una línea con
// - Comentarios de bloque dentro de
/*y*/
Ejemplo de código HTML con el elemento <script>:
<script>
// Comentario de una línea
let lang = "JS" // Comentario
/* Este comentario
está compuesto por
múltiples líneas. */
</script>
Validación de comentarios
Tal y como ocurre en cualquier otro lenguaje de programación, hay que tener especial cuidado en cerrar bien los comentarios de bloque. Si se indica la etiqueta de apertura (/*) pero no se indica la de cierre (*/), el comentario no se cerrará hasta encontrarla. Como resultado, devolverá error de sintaxis. En términos generales, suele ser más seguro usar comentarios de línea.
