tutz

Comentarios en JavaScript: de una línea y multi línea

Los comentarios líneas de código que JavaScript ignora intencionalmente. Y nos sirven para agregar notas a nuestro código ya sea para nosotros mismo o para cualquier otra persona que lea o trabaje con lo que estamos desarrollando.

Los comentarios son una buena practica a la hora que desarrollamos software, aunque tampoco debemos agregar comentarios a todo nuestro código. Lo ideal es agregar los comentarios que nos vayan a servir mas adelante al cualquiera que trabaje con el software que estamos desarrollando.

En JavaScript tenemos dos formas de agregar comentarios:

Comentario de una línea

Para agregar comentarios a una línea de código debemos anteponer // y todo lo que se escriba después de estos signos, JavaScript los va a ignorar. Por ejemplo:

// Este es un comentario de una línea

Comentario multiples líneas

Si queremos agregar comentarios más extensos podemos hacer uso de /* */, dentro podemos agregar cualquier nota que queramos y JavaScript no lo tomará en cuenta.

Por ejemplo:

/* Este es un comentario
de varias
líneas */

Usos y recomendaciones

Uno de los usos más extendidos de los comentarios es para generar documentación. Muchas librerías, como jsDoc, nos permiten crear una documentación completa de nuestro desarrollo solo basándose en los comentarios.

La principal recomendación que te puedo dar es que agregues comentarios, siempre que sea necesario, para clarificar algunas partes de tu código que necesiten de más información para tu yo del futuro o para cualquier otra persona que use tu código.