En este tutorial, aprenderá acerca de los comentarios de JavaScript, por qué debería usarlos y cómo usarlos con la ayuda de ejemplos.
Los comentarios de JavaScript son sugerencias que un programador puede agregar para que su código sea más fácil de leer y comprender. Los motores JavaScript los ignoran por completo.
Hay dos formas de agregar comentarios al código:
//- Comentarios de una sola línea/* */-Comentarios de varias líneas
Comentarios de una sola línea
En JavaScript, cualquier línea que comience con //es un comentario de una sola línea. Por ejemplo,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Aquí // printing name on the consolehay un comentario.
También puede usar un comentario de una sola línea como este:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Comentarios de varias líneas
En Javascript, cualquier texto entre /*y */es un comentario de varias líneas. Por ejemplo,
/* The following program contains the source code for a game called Baghchal. Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid. For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board. For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal. */
Dado que el resto del código fuente se utilizará para implementar las reglas del juego, el comentario anterior es un buen ejemplo en el que puede utilizar un comentario de varias líneas.
Usar comentarios para depurar
Los comentarios también se pueden utilizar para deshabilitar el código y evitar que se ejecute. Por ejemplo,
console.log("some code"); console.log("Error code); console.log("other code");
Si obtiene un error mientras ejecuta el programa, en lugar de eliminar el código propenso a errores, puede usar comentarios para deshabilitar su ejecución; esta puede ser una valiosa herramienta de depuración.
console.log("some code"); // console.log("Error code); console.log("other code");
Consejo profesional: recuerde el atajo para usar comentarios; puede ser realmente útil. Para la mayoría de los editores de código, es Ctrl + /para Windows y Cmd + /Mac.
Haga que el código sea más fácil de entender
Como desarrollador de JavaScript, no solo escribirás código, sino que también tendrás que modificar el código escrito por otros desarrolladores.
Si escribe comentarios sobre su código, le resultará más fácil comprender el código en el futuro. Además, será más fácil para sus compañeros desarrolladores comprender el código.
Como regla general, utilice comentarios para explicar por qué hizo algo en lugar de cómo hizo algo, y es bueno.
Nota: Los comentarios no deben sustituir una forma de explicar el código mal escrito en inglés. Siempre debe escribir un código bien estructurado y autoexplicativo. Y luego usa comentarios.
