Ejemplos de Comentario En JavaScript

Los comentarios son una parte esencial de cualquier código fuente, ya que proporcionan información adicional y aclaraciones a los desarrolladores que trabajan en el proyecto. También son útiles para ti mismo cuando vuelvas a visitar tu propio código en el futuro. En este artículo, aprenderás cómo escribir  diferentes tipos de comentarios en JavaScript.

Comentarios de una línea en JavaScript

En JavaScript, puedes utilizar dos barras inclinadas // para crear un comentario de una sola línea. Todo el texto que sigue a las barras inclinadas hasta el final de la línea será tratado como un comentario y no será interpretado por el navegador. EJemplo:

<script type="text/javascript">
// Esto es un comentario de una línea
let x = 5; // Este comentario está al final de la línea y explica la variable x
</script>

Comentario de varias líneas

Si deseas escribir un comentario que abarque varias líneas, utiliza la sintaxis de comentario de bloque. Un comentario de bloque comienza con una barra inclinada y un asterisco /* y termina con un asterisco y una barra inclinada */.

<script type="text/javascript">
/*
Esto es un comentario de varias líneas.
Puedes escribir tanto texto como desees aquí,
y se extenderá a través
de
múltiples
líneas.
*/
let y = 10;
</script>

Comentarios para documentar funciones y clases

Cuando documentas funciones, clases o métodos en JavaScript, puedes utilizar la notación JSDoc. JSDoc es un estándar de documentación que utiliza una sintaxis especial para proporcionar información detallada sobre cómo funcionan las diferentes partes del código.

<script type="text/javascript">
/**
* Suma dos números y devuelve el resultado.
*
* @param {number} a - El primer número a sumar.
* @param {number} b - El segundo número a sumar.
* @returns {number} - La suma de a y b.
*/
function suma(a, b) { return a + b; }
</script>