JavaScript no es una excepción y como casi todos los lenguajes permite el uso de líneas de comentarios dentro del propio código fuente. Los comentarios bien colocados, concisos y precisos son una bendición para el programador que debe realizar un mantenimiento sobre un código realizado por otro; no es cuestión de escribir una novela antes de cada sentencia ya que ése es un defecto que debemos evitar, sino de saber explicar el objetivo de cada bloque de código que no quede claro a primera vista, debemos tener en cuenta que las sentencias escritas en JavaScript pueden ser autoexplicativas cuando se utiliza una correcta nomenclatura de variables (que trataremos más adelante) y cuando se utilizan las instrucciones esperadas dentro del punto de vista lógico.
Los comentarios son líneas no ejecutables por lo que su inclusión no incrementa el tiempo de ejecución del código.
Los comentarios JavaScript se puede especificar de tres modos diferentes:
// Esto es un comentario num = 5; /* esto es un comentario */ num = 5; num = 5; // Esto es un comentario
La forma /* …*/ permite que un comentario se extienda por más de una línea hasta llegar al indicador de cierre (*/).
Como regla general un comentario debe ser concreto y conciso con un texto que explique el objetivo del bloque de código siguiente y no debe explicar lo que resulta obvio por la simple lectura de la instrucción.
Si bien los comentarios no se ejecutan en el navegador, los comentarios viajan hasta el navegador como parte del archivo JavaScript y el cliente los puede visualizar con la opción Ver código fuente (o como se denomine en los distintos navegadores) por lo que no se debe incluir información que afecte la seguridad del sitio (contraseñas, cadena de conexión, etc.).
| Cuando se realiza una modificación en un programa es aconsejable incluir un comentario que indique la fecha de la modificación, en el futuro puede ser un dato que nos aporte una información que nos ayude en la tarea de mantenimiento. |
|
|
|
