Comentarios
Usa comentarios para explicar código o deshabilitar líneas temporalmente.
Resumen Rápido
Los comentarios son ignorados por el motor de JavaScript, así que no cambian el comportamiento del programa. Úsalos para aclarar intenciones, documentar lógica compleja o dejar notas para tu yo futuro y compañeros de equipo. Los buenos comentarios explican POR QUÉ el código hace algo, no QUÉ hace (el código mismo lo muestra). Evita comentar en exceso código obvio, pero sí comenta algoritmos complejos, lógica de negocio y soluciones temporales.
Por Qué Importan los Comentarios
Los comentarios sirven para múltiples propósitos en programación:
- Documentación: Explicar el propósito de funciones, clases o módulos
- Clarificación: Describir algoritmos complejos o lógica no obvia
- TODOs: Marcar áreas que necesitan trabajo futuro
- Depuración: Deshabilitar código temporalmente sin eliminarlo
Tipos de Comentarios en JavaScript
Comentarios de una línea comienzan con // y continúan hasta el final de la línea:
// This is a single-line comment
const price = 19.99; // Price in USD
Comentarios de múltiples líneas se envuelven en /* */ y pueden abarcar varias líneas:
/*
This function calculates the total price
including tax and any applicable discounts.
Author: Development Team
Last updated: 2024
*/
function calculateTotal(price, tax, discount) {
return (price + tax) - discount;
}
Mejores Prácticas para Comentarios
- No digas lo obvio:
const count = 0; // Set count to 0es innecesario - Explica el "por qué":
const count = 0; // Reset for new user sessiones útil - Mantén los comentarios actualizados: Los comentarios desactualizados son peores que no tener comentarios
- Usa etiquetas TODO/FIXME:
// TODO: Add error handling for edge cases
Pruébalo Tú Mismo
Aquí tienes un ejemplo práctico que puedes probar. Copia este código y ejecútalo en la consola de tu navegador (presiona F12 para abrir las herramientas de desarrollo) o en el Playground de Código.
// Single-line: explain a tricky calculation
const total = price * 1.08; // Add 8% sales tax
// Temporarily disable code for debugging
// console.log("Debug:", total);
/* Multi-line comment for documentation
This function processes user input
and returns formatted output */
function processInput(input) {
return input.trim().toLowerCase();
}Puntos Clave
- ✓Usa comentarios para explicar código o deshabilitar líneas temporalmente.
- ✓Practica con ejemplos de código reales para solidificar tu comprensión
- ✓Este concepto construye la base para temas más avanzados
Recursos de Aprendizaje Relacionados
Continúa tu camino de programación con estos tutoriales relacionados: