Comentarios

Los comentarios son declaraciones que no serán ejecutandos por el intérprete, los comentarios son utilizados para marcar anotaciones para otros programadores o pequeñas descripciones de lo que el código hace, facilitando así que otros comprendan lo que hace su código. También se utilizan para desactivar temporalmente el código sin afectar al control de flujo del programa.

Tipos de comentarios

Comentarios de línea única

Empiezan con dos barras diagonales (//) y continúa hasta el final de la línea. El intérprete de JavaScript ignora todo lo que sigue a las barras diagonales. Por ejemplo:

// Esto es un comentario, será ignorado por el intérprete
let a = "esto es una variable definida en una declaración";

Puedes usarlos también al final de la línea:

let b = 5; // Esto est también un comentario de una línea válido

Comentarios multilínea

Comienzan con una barra diagonal y un asterisco (/*) y terminan con un asterisco y una barra diagonal (*/). El intérprete de JavaScript ignora todo lo que se encuentre entre los marcadores de apertura y cierre. Por ejemplo:

/*
Esto es un comentario multilínea,
será ignorado por el intérprete
*/
let a = "esto es una variable definida en una declaración";

Ejemplos de comentarios de la vida real

// Cambio de la cabececera:
document.getElementById("myH").innerHTML = "Mi Primera Página";

// Cambio de párrafo:
document.getElementById("myP").innerHTML = "Mi Primer Párrafo.";

/*
  Mensaje de bienvenida deshabilitado temporalmente mientras se comprueba el nuevo flujo de la IU
*/

/*
document.getElementById("myH").innerHTML = "¡Bienvenido de nuevo!";
document.getElementById("myP").innerHTML = "Nos alegra verte de nuevo.";
*/

También son útiles para propósitos de depuración:

let total = 0;
// total = calculateTotal(items); // Deshabilitado temporalmente durante la prueba

/*
  Depurando trazas por problema de autenticación
  Comentado después de resolver el problema
*/

/*
console.log("Datos del usuario:", user);
console.log("Token de autenticación:", token);
console.log("Respuesta de la IPA:", response);
*/

Incluir comentarios en el código es esencial para mantener la calidad del código, habilitando la colaboración, y simplificando el proceso de depuración. Al proporcionar contexto y explicaciones para varias partes del programa, los comentarios facilitan la comprensión del código en el futuro. Por lo tanto, se considera una práctica beneficiosa incluir comentarios en el código.