Si eres desarrollador web, sabrás lo importante que es el código JavaScript en la creación de una página web dinámica y funcional. Sin embargo, a veces puede resultar difícil entender el propósito o el funcionamiento de ciertas líneas de código. Es aquí donde la adición de comentarios se vuelve esencial para una mejor comprensión y mantenimiento del código. En este artículo te enseñaremos cómo agregar comentarios al código JavaScript de manera fácil y efectiva. ¡No te lo pierdas!
Si quieres ser un buen guionista/programador, se recomienda encarecidamente que considere seriamente agregar comentarios dentro de su código. Por un lado, tener comentarios hará que sea mucho más fácil para usted o para otra persona vuelve a leer tu código. Cuanto más tiempo pasa desde que escribió el código original hasta que vuelve a revisarlo, más valiosos se vuelven esos comentarios.
Los comentarios de HTML y JavaScript se utilizan en el mismo bloque, pero tienen diferentes propósitos.
El comentario HTML se utiliza para evitar que el código JavaScript aparezca como texto sin formato para aquellos usuarios que ejecutan una versión anterior del navegador que no es compatible con JavaScript.
El Comentarios de JavaScript se utilizan para agregar una notación a su código JavaScript o evitar que se ejecute una instrucción JavaScript durante el proceso de depuración.
Los comentarios de una sola línea comienzan con //.
La siguiente ejemplo muestra el uso de un comentario de una sola línea.
<script type="text/JavaScript">
<!--
// This is an alert
alert("Alert #1");
// This is another alert
alert("Alert #2");
//-->
</script>Puede haber casos en los que necesite agregar comentarios de varias líneas a sus guiones. Si bien podría simplemente agregar barras dobles al comienzo de cada línea, no es tan conveniente. Aquí es donde se pueden usar las etiquetas de comentarios de varias líneas.
Los comentarios de varias líneas consisten en la etiqueta de comentario de apertura /*los comentarios en sí, seguidos de la etiqueta de comentario de cierre */.
Aquí hay un ejemplo de un comentario de varias líneas:
<script type="text/JavaScript">
<!--
/* The following two functions will result in
your browser displaying two pop-up windows.
After you click OK on the first box, the second
pop-up window will appear. */
alert("Alert #1");
alert("Alert #2");
//-->
</script>Si bien puede parecer una tarea tediosa, tómese el tiempo para agregar comentarios significativos. No solo hace que tu JavaScript más fácil de leer pero también te ayuda solucionar problemas errores en el guión.
