Imagen destacada del artículo Cómo poner comentarios en javascript

Cómo poner comentarios en javascript

javascript svg
actualizado: 29 / 09 / 2022

¿Qué es un comentario en javascript?

Un comentario es una forma de documentar y anotar lo que hace nuestro código por ejemplo si escribo una función para filtrar una array de objetos puede ser de gran utilidad dejar algunas notas sobre algún proceso importante que realice nuestra función.

A pesar de que comentar tu código puede parecer una buena práctica tampoco debemos abusar de ello ya que si dejamos muchos comentarios nuestro código se verá sucio y dependiendo de lo largo que sea podría convertirlo en un código complicado de leer. Más adelante tienes algunos consejos para utilizar de forma correcta los comentarios.

Nota importante:

los comentarios también pueden tener código pero al estar declarado como comentario este no se ejecutará

Tipos de comentarios en javascript

Existen dos formas de comentar nuestro código en js

  • Poner comentarios de una línea en js

    Este tipo de comentarios tal y como su nombre lo indica cubren solo una línea del código y para utilizarlos debes anteponer dos barras como estas // este tipo de comentario se suele utilizar para explicar el código de la siguiente línea.

    js
    //Esto es un comentario de una línea
    // Esta variable guarda una cadena con un mensaje de bienvenida
    const saludo = "Hola bienvenido"; //también se puede poner un comentario después del código
  • Poner comentarios de múltiples líneas js

    Este tipo de comentarios pueden cubrir varias líneas y suelen ser utilizados para explicar partes del código más complejas que requieren de una explicación mucho más profunda se abren con una barra y un asterisco (/*) y se cierran con un asterisco y una barra (*/)

    js
    /*
    Esto es un comentario de múltiples líneas
    Para documentar partes del código complejas
    */
    const saludo = "Hola bienvenido";

Consejos para usar comentarios en js

Principalmente usamos los comentarios para dejarnos notas a nosotros mismos o a otros programadores que puedan trabajar en nuestro código en el futuro así que debemos tratar en los posible de escribir funciones con nombres claros que expliquen claramente de que se encargará dicha función.

Logrando así reservar los comentarios para partes específicas del código en las que por x o y no podamos explicar en su declaración cual es el objetivo de este dentro de nuestro trabajo.