Comentarios y código ordenado

Seguro te preguntas para qué sirve escribir algo que la computadora ni lee. Piénsalo así: un programa lo lee la computadora, pero también lo lees tú, hoy y dentro de tres meses. Los comentarios son notas que escribes para las personas. La computadora los ignora por completo.

Para qué sirve un comentario

Imagina que dejas una nota pegada en el refrigerador: «No te comas el pastel, es para la fiesta». La nota no es parte del pastel; solo explica algo a quien la lea. Un comentario hace lo mismo dentro del programa.

Un comentario:

• sirve para explicar por qué hiciste algo,
• sirve para recordarte algo pendiente,
• sirve para apagar una instrucción un rato sin borrarla.

Comentario de una línea

Empieza con dos barras //. Todo lo que está a la derecha, hasta el final de la línea, es comentario.

Debe salir una sola línea en la consola: Esta línea sí se ejecuta. Las notas no aparecen en ninguna parte, porque JavaScript las salta.

Comentario de varias líneas

Empieza con /* y termina con */. Todo lo que queda en medio es comentario, sin importar cuántas líneas ocupe.

Debe salir: Hola, comentarios. Todo el recuadro del principio fue ignorado.

Apagar una instrucción para probar

Esta es la función más útil para quien está aprendiendo. Si no sabes si una línea causa un problema, ponle // al principio. La línea queda «dormida»: sigue ahí, pero no se ejecuta. Cuando quieras reactivarla, quítale el //.

A esto se le llama comentar una línea. Quitarle el comentario es descomentar.

Debe salir Primera línea y Tercera línea. La segunda no aparece. Quita las dos barras de la línea del medio, ejecuta de nuevo, y ahora aparecen las tres.

Un comentario dentro de un texto no es comentario

Si // aparece dentro de comillas, es parte del texto. JavaScript lo escribe tal cual.

Debe salir la dirección completa, incluyendo las dos barras. Las barras solo son comentario cuando están fuera de las comillas.

Código ordenado: sangría y líneas en blanco

La sangría es el espacio que dejas al comienzo de una línea para mostrar que está «dentro» de otra cosa. En este curso verás dos espacios dentro de cada <script>. Hace que el código se lea como un esquema.

Las líneas en blanco separan grupos de instrucciones, como los párrafos separan ideas en un texto.

Compara estos dos programas. Hacen lo mismo, pero uno es mucho más fácil de leer:

Deben salir primero las cuatro líneas de la versión desordenada y luego las cuatro de la ordenada. Ambas funcionan; solo una es cómoda de leer.

Comentarios buenos y comentarios malos

Un comentario ayuda cuando explica el porqué.

Un comentario estorba cuando repite lo que ya dice el código:

// Malo: repite lo obvio
// Escribe Hola en la consola
console.log("Hola");

// Bueno: explica una razón
// Uso 12 porque es el precio de la docena de huevos
console.log(12 * 3);

Regla simple: si el código ya se explica solo, no hace falta comentario. Si hay una razón que no se ve, escríbela.

Errores comunes

• Olvidar cerrar un comentario largo con */: todo lo que sigue queda comentado y el programa falla con un error de escritura (Invalid or unexpected token) que no dice dónde olvidaste el cierre.
• Poner // en una línea y esperar que afecte a la siguiente. El comentario de una línea solo cubre esa línea.
• Dejar muchísimo código viejo comentado. Cuando una línea ya no sirve, bórrala.
• Escribir comentarios que dicen lo contrario de lo que hace el código (porque cambiaste el código y no el comentario). Revisa los comentarios al cambiar algo.

Haz que en la consola solo aparezcan «Línea A» y «Línea C», sin borrar ninguna instrucción: apaga las otras dos con //. Agrega además un comentario al principio que diga qué hace el programa. Luego descomenta una línea y comprueba que reaparece.

Apaga con un solo comentario de varias líneas las dos instrucciones del medio («Recreo» y «Almuerzo»), sin borrarlas. En la consola deben quedar solo la «Entrada» y la «Salida».

Este programa funciona, pero está todo apretado en una sola línea. Déjalo igual de bien en la consola, pero fácil de leer: cada instrucción en su línea, una línea en blanco entre el título y los pasos, y una nota con // que diga qué hace.

En la próxima lección verás los errores: cómo leerlos, por qué aparecen y cómo arreglarlos sin miedo.