Los comentarios en JavaScript son fragmentos de texto que se incluyen en el código, pero que no se ejecutan. Son muy útiles para dejar notas, explicar partes del código, o desactivar temporalmente algunas líneas sin borrarlas.

Ten cuidado con el uso de comentarios. A menudo, la necesidad de comentar el código puede ser una señal de que tu código no está bien estructurado o es difícil de entender. En lugar de depender excesivamente de los comentarios, es preferible escribir un código limpio y claro que se explique por sí mismo.

Un gran problema de los comentarios es que pueden quedar desactualizados si no se actualizan junto con el código. Asegúrate de mantener tus comentarios actualizados y precisos.

Tipos de comentarios en JavaScript

1. Comentarios de una sola línea:
   • Se utilizan para escribir notas breves.
   • Comienzan con dos barras inclinadas //.
   • Todo lo que escribas después de // en esa línea será ignorado por el navegador.
   • Ejemplo:

      
     1// Esto es un comentario de una sola línea
     2let nombre =   "Juan"; // Esto también es un comentario
     3console.log(nombre);
     Salida de Consola!:
     Juan

2. Comentarios de varias líneas:
   • Se usan cuando necesitas escribir comentarios más largos que abarcan varias líneas.
   • Empiezan con /* y terminan con */.
   • Todo lo que esté entre /* y */ será ignorado por el navegador.
   • Ejemplo:

      
     1/*
     2Esto es un comentario de varias líneas.
     3Aquí puedes explicar algo más detalladamente.
     4Todo este texto será ignorado por el navegador.
     5*/
     6let edad = 25;
     7console.log(edad);
     Salida de Consola!:
     25

¿Por qué usar comentarios?

• Documentación: Ayudan a explicar qué hace una parte del código, lo que es útil para ti o para otros que lean tu código en el futuro.
• Depuración: Puedes desactivar temporalmente partes del código agregando // o /* */ alrededor.
• Organización: Facilitan la organización del código, separando diferentes secciones o funciones con comentarios.

Ejemplo de comentarios en un código real

 
1// Esto es un saludo básico
2console.log("Hola, mundo!");
3
4/*
5  A continuación, definimos un objeto persona.
6  Este objeto tiene un nombre y una edad.
7*/
8let persona = {
9  nombre: "Ana",
10  edad: 28
11};
12
13// Mostramos el objeto en la consola
14console.log(persona);
Salida de Consola!:
Hola, mundo!
{ nombre: 'Ana', edad: 28 }

Buenas prácticas

• Sé claro y conciso: Usa comentarios para aclarar cosas importantes, pero evita escribir demasiado o cosas obvias.
• Actualiza tus comentarios: Asegúrate de que los comentarios sigan siendo válidos si cambias el código.

Tipos de uso de comentarios (algunos incorrectos)

❌ Comentario mentiroso: Ocurre cuando el comentario no describe lo que realmente hace el código, ya sea porque el código ha cambiado y el comentario no se actualizó o simplemente fue incorrecto desde el principio

1// Suma dos números
2function calculo(a, b) {
3    return a - b;
4}

❌ Comentario Redundante: escribe exactamente lo que ya es evidente en el código. No añade ningún valor adicional porque el código ya es lo suficientemente claro

1// Inicializa el contador en 0
2let contador = 0;

❌ Comentario que se podría evitar: si el código es lo suficientemente claro por sí solo, no es necesario agregar un comentario

1// Calcula la longitud de un vector
2let x = 5;
3let y = 3;
4const valor = Math.sqrt(x * x + y * y)

1function calcularLongitud(x, y) {
2    return Math.sqrt(x * x + y * y);
3}
4const valor = calcularLongitud(5,3)

✅ Comentario Útil: Proporciona información que no es obvia a partir de la lectura directa del código, como el propósito del código, el contexto, o aclaraciones sobre por qué se tomó una decisión particular en la implementación.

1/**
2 * Convierte una temperatura de grados Celsius a Fahrenheit.
3 * 
4 * Fórmula: (Celsius * 9/5) + 32
5 * 
6 * @param {number} celsius - La temperatura en grados Celsius que se desea convertir.
7 * @returns {number} La temperatura equivalente en grados Fahrenheit.
8 * 
9 * Ejemplo de uso: Si la temperatura es 0°C, la función devolverá 32°F.
10 */
11function convertirCelsiusAFahrenheit(celsius) {
12    return (celsius * 9/5) + 32;
13}

Los comentarios son una herramienta sencilla pero poderosa para mantener tu código limpio, organizado y fácil de entender.