Ejemplo de Comentario En JavaScript

Inicio » JavaScript » 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>

¿Cómo citar? Pichardo, A. & Del Moral, M. (s.f.). Ejemplo de Comentario En JavaScript.Ejemplo de. Recuperado el 26 de Septiembre de 2023 de https://www.ejemplode.com/24-javascript/514-ejemplo_de_comentario_en_javascript.html

Escrito por:
Aziel Pichardo
Ingeniería en Sistemas
Universidad del Estado de Guanajuato
Mauricio del Moral Durán
Mauricio del Moral, fundador y creador de Ejemplo de, es un experto en enseñanza y un apasionado del ámbito educativo desde el año 2007. Ha dedicado una considerable parte de su vida profesional al estudio y al desarrollo de contenidos educativos en formatos digitales de alta calidad. Poseedor de una Licenciatura en Ciencias de la Comunicación, Mauricio es egresado de la prestigiosa Universidad Intercontinental.
Última modificación: 2023-04-07

Últimos 10 comentarios

  1. // Comentario de una línea document.write (\" Viva yo! (prueba) \");
    Por Jvd 2013-07-21 a las 23:17:08
  2. mmm como consigo que me manden un tutorial para crear este sistema de comentarios en javasscript?
    Por jaiem 2011-09-30 a las 20:08:06
  3. se esta probando
    ah se crea en html
    debido a que el comando script
    es un programador
    puede hacer algo por si solo ejm
    ordena cuente del 1 al 20 y los arroje
    en la web
    eso puede hacer tmb osea es como
    c++
    c
    lenguajes de programacion
    Por Jhonathan 2011-03-29 a las 14:46:21




  4. // Comentario de una línea
    document.write(\"Lo que se comenta, no se escribe\");





    Por dgndfngdfnd 2011-03-29 a las 14:42:41
  5. Mensaje de Prueba para ver resultados e implementar en sitio web
    Por Boris Vergara Ibarra 2011-02-28 a las 15:50:14
  6. a ver aha, claro, primero se tiene que revisar
    Por no funciona tío 2011-01-23 a las 11:05:30
  7. Digo... ya que toso estamo comprobando que lo que dicen arriba es cierto. Mi contraseña es:/*kurchatov*/jejeje...
    Por Cerztse 2011-01-05 a las 7:20:23
  8. me gusta este tipo de comentarios
    Por israel 2010-10-28 a las 19:29:41

  9. /*
    Este es un comentario
    por bloque. Sin importar
    la cantidad de líneas.
    */
    document.write("Lo que se comenta, no se escribe");

    Por Anonimo 2010-10-18 a las 2:58:33
  10. Jejeje ke chevere este foro
    Por heider 2010-07-07 a las 17:14:02

Deja un comentario


Acepto la política de privacidad.