Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

Comentarios y documentación

Los comentarios describen la intención del código sin ejecutar su contenido. Aprende las sintaxis // y /* ... */, la convención de documentación /** ... */ y cómo los terminadores de línea pueden afectar al análisis del programa.

Versión: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxis

// comment
/* block comment */
/** documentation comment */

Los comentarios explican el código, sobre todo las razones de las decisiones y las restricciones. Su contenido no se ejecuta como JavaScript. Recomendación editorial: explica principalmente el «por qué», en lugar de repetir lo que hace una instrucción evidente.

// inicia un comentario que llega hasta el final de la línea o del código fuente; el terminador de línea no forma parte del comentario. /* ... */ puede ocupar parte de una línea o varias líneas y termina en el primer */. Los comentarios de bloque no se pueden anidar.

Para ECMAScript, /** ... */ es un comentario de bloque normal. La notación de documentación no cambia el comportamiento de una función ni impone tipos; interpretar anotaciones adicionales es tarea de las herramientas, no parte de la sintaxis del lenguaje.

Los comentarios se comportan como espacios en blanco, con una excepción importante: durante el análisis sintáctico, un comentario de bloque que contiene un terminador de línea se trata como si fuera un terminador de línea. Esto puede afectar a la inserción automática de punto y coma (ASI), por ejemplo después de return. No separes return del valor que devuelve mediante un comentario de este tipo. La forma independiente #! solo se permite al principio del texto fuente de un Script o un Module.

Ejemplos

/** Compute the total price. */
function total(price, quantity) {
  // Keep the calculation in one place.
  return price * quantity;
}

const result = total(7, /* quantity */ 3);
console.log(result);

Resultado

21

El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.

Fuentes