Los comentarios son lineas de texto que no van a ser interpretadas por JavaScript.
No importa si el comentario es alguna instrucción o si el comentario se encuentra dentro de una sección que contiene código, el contenido va a ser ignorado.
Comentario de una línea
// Comentario de una línea
Comentario de dos o más líneas
/*
Este comentario puede utilizar
más de una línea.
*/
Ejemplo
function prueba_comentario() {
var test
test = 1
for (var i = 1; i < 10; i++) {
test *= i
// console.log( "test: " + test + " i: " + i)
}
return test
}
/*
La línea comentada mostraba el valor de la variable test e i
en cada iteración
*/
Algunos usos de los comentarios son:
Documentar la funcionalidad escrita en algunas partes del código
TODO – Describir lo que falta por hacer.
FIXME – Tener una referencia hacia parte(s) del código que no funciona(n).
Incluir licencia de uso, distribución y autoría del código.
Instrucciones de uso – README (LÉAME).