1.11 Commentarios
El empleado de una tienda de telefonos tal vez tome apuntes sobre una caracteristica, una nueva version o un nuevo plan que la compañia ofrece. Estas notas son solo para el empleado -- esta notas no son para que el cliente --. No obstante, estas notas del como y porque ayudan al empleado hacer mejor su trabajo para que la empleada diga lo que deberia decir a los clientes.
Una de las lecciones mas importantes que puede aprender sobre programar es que el codigo no solo es para la computadora. El codigo es igual de importante, si no mas, para el dasarrollador como lo es para el compilador.
A su computadora solo le interesa el codigo para la computadora. Una serie de 0s y 1s binarios, que resultan de la compilacion. Hay un numero casi infinito de programas que usted puede escribir y producir la misma serie de 0s y 1s. La eleccion que hace de como escribir su programa importa -- no solo por usted, sino para el resto de su equipo e incluso para usted mismo en el futuro.
Usted no deberia solo esforzarse por escribir programas que trabajen bien, si no tambien en programas que tengan sentido cuando sean revisados. Usted puede emprender un largo camino en esa oportunidad de escojer buenos nombres para sus variables(ver "Variables") y funciones (ver "Funciones").
Pero otra parte importante del codigo son los comentarios. Estos son bits de texto que son insertados en su programa solamente para explicar las cosas a los humanos. El interprete/compilador siempre ignorara estos comentarios.
Hay montones de opiniones de como hacer codigo bien comentado; realmente no se puede definir reglas universales absolutas. Pero algunes observaciones y directrices son muy utiles.
- Un codigo sin comentarios no es optimo
- Muchos comentarios(ej: uno por linea) posiblemente es una señal de codigo mal escrito
- Los comentarios deberian explicar el por que y no el que. U opcionalmente puede explicar el como, si llega es particularmente confuso.
En JavaScript, hay dos tipos de comentarios posibles: comentario de una sola linea y comentarios multilineas.
Considere:
// Esto es un comentario de una sola linea
/*
Pero esto es
un comentario
multilinea.
*/
El comentario de una linea // es apropiado si va a poner un comentario justa al lado derecho de una sentencia, o incluso al final de la linea. Todo luego del */ es tratado como comentario(por lo tanto ignorado por el compilador), toda la linea hasta el final de la linea. Esta tipo de comentario no tiene restriccion acerca de lo que puede aparecer en un comentario de una linea.
Considere:
var a = 42; // 42 is the meaning of life
El comentario multilinea /* ... */ es apropiado si tiene que explicar muchas lineas importantes en su comentario.
Aqui hay un uso comun para los comentarios multilinea:
/* El siguiente valor es usado ya que
se ha demostrado que responde
a todas las pregunta en el universo */
var a = 42;
Tambien puede aparecer en cualquier lugar de una linea, incluso en medio de una linea, ya que el */ lo finaliza. Por ejemplo:
var a = /* valor arbitrario */ 42;
console.log( a ); // 42
La unica cosa que no puede aparecer dentro de un comentario multilinea es */, ya que eso seria interpretado como el final del comentario.
Usted definitivamente querra iniciar su aprendizaje en la programacion iniciando con el habito de comentar el codigo. Durante el resto de este capitulo, vera que uso comentarios para explicar cosas, asi que haga lo mismo en sus practicas. Creame, quienes lean su codigo se lo agradeceran.