Los comentarios en JavaScript - Curso de JavaScript de cero a máster - Capítulo 7


En este séptimo capítulo vas a ver para que son los comentarios y cuales son las formas de crearlos. Un tema muy simple pero importante.

Los comentarios en JavaScript

Algo indispensable en cualquier lenguaje de programación son los comentarios.
¿Para qué son?
Son para anular trozos de código que no queremos borrar por si necesitamos más tarde, para ir anotando para que sirve cada parte del código, para dar consejos, pequeñas sugerencias, advertencias, etc. de esta forma, sabremos en el futuro de un vistazo para que sirve cada parte y lo sabrán otros desarrolladores que lean nuestro código.

Javascript tiene dos tipos de comentarios antiguos, es decir que llevan desde sus inicios. El de una sola línea y el multilínea. También hay una tercera forma más moderna que veremos al final de este capítulo.

Comentarios JavaScript

Comentarios de una línea de JavaScript

Código JavaScript

//let numero1 = 77;
let numero1 = 88;

La primera línea está comentada. Si llamases a numero1 en un console.log() ¿qué crees que pasaría?, ¿habría algo incorrecto o errores por estar declarada dos veces la misma variable con let?

La respuesta es que no. Todo correcto, ya que la primera línea, al estar comentada, es ignorada por el navegador. Es como si no existiera. Puedes anular código o hacer cualquier tipo de comentario, nunca te dará un error.

Estos comentarios también se pueden poner a modo explicativo al final de la línea de código sin anularla, a modo de feedback (retroalimentación) o cualquier cosa que se te ocurra.

Código JavaScript

let numero1 = 77; //Este es el primer número para realizar la operación.
let numero2 = 88; //Este es el segundo número para realizar la operación.

Evidentemente, no hace falta que vayas escribiendo línea por línea lo que hace el código. Cuando escriba código más complejo, algunas veces incluiré comentarios y te harás una idea de cuando utilizar comentarios. Por ejemplo, si tienes tres funciones en un código, pues escribes tres comentarios indicando brevemente lo que hacen. Si están relacionadas, quizás te baste con un comentario. La cuestión aquí es documentar el código para que cuando lo edites más adelante o lo edite otra persona, sepa rápidamente donde está cada cosa y como funciona. Mira si son importantes.

Los comentarios multilínea en JavaScript

Pasamos al segundo tipo de comentarios, los multilínea. Para estos debemos utilizar en lugar de la doble barra, una barra y el símbolo asterísco para la apertura (/*) y lo mismo pero a la inversa para el cierre (*/).

Código JavaScript

/* let numero1 = 77;
let numero1 = 88; */

De esta forma, se anulan todas las líneas englobadas, no solo dos como en el ejemplo, todas las que quieras.

También he visto más de una vez escribirlos así:

Código JavaScript

/* let numero1 = 77;
* let numero2 = 88;
* let numero3 = 99;
* let numero4 = 00;
* let numero5 = 11; */

Estos asteríscos extra en cada línea no representan nada, solo es organizativo y cuestión de gustos.

Al poder anular bloques enteros de código, podemos utilizar los comentarios como una herramienta de depuración, ya que podremos y comentando trozos y ver lo que ocurre sin ellos, de modo que encontremos fallos.

Malas prácticas con los comentarios

Las primeras malas prácticas ya te las he dicho, no poner comentarios es una mala práctica. Poner demasiados también.

Otra mala práctica es incluir comentarios entre el propio código. Algo que puede hacerlo más malo de leer y crear confusiones. Aquí tienes un ejemplo:

Código JavaScript

let numero1 = /* Aquí va un valor numérico */ 77;

Si que puedes utilizar un comentario multilínea en una sola línea, lo que no es nada legible es añadir comentarios en medio del código. En este caso, con lo poco que te he enseñado hasta ahora, puede que no lo veas bien, pero si las líneas son muy elaboradas como por ejemplo una ecuación en una función con varias línes de operaciones matemáticas y las vas mezclando con comentarios por enmedio, va a ser un verdadero trauma para quien toque ese código.

Los comentarios hashbang de JavaScript

Palabra del lenguaje nº 22 encontrada.
hashbang es el más moderno de los tipos de comentarios en JavaScript.

Se trata de una de las novedades de JavaScript. Los comentarios hashbang solo se pueden utilizar una sola vez en todo un documento o script de JavaScript y al absoluto comienzo, aquí no vale ni un espacio en blanco, mira los siguientes ejemplos:

Sin errores:

Código JavaScript

#!
let numero1 = 77;

Código JavaScript

#! let numero1 = 77;

Con errores:

El siguiente código produce un error, ya que no puede haber ningún espacio en blanco antes de este comentario.

Código JavaScript

 #!
let numero1 = 77;

Desde luego, los comentarios hashbang no están hechos para anular una línea de código aunque lo puedan hacer una sola vez por documento o fragmento de código. Están diseñados para poder especificar la ruta a un intérprete de JavaScript en concreto que ejecute todo el script. Aquí tienes un ejemplo:

Código JavaScript

 #!/usr/bin/env node

No profundicemos más en este tema de los hashbang hasta tener que utilizarlos. De momento, utiliza solo el comentario multilína y el de una sola línea.


Ejercicios de JavaScript

  1. ¿Qué salida devuelve el siguiente código en la consola?

  2. let numero1  //   este es un número bigint //  = BigInt(100);
    console.log(typeof numero1);
  3. ¿Qué salida devuelve el siguiente código en la consola?

  4. let numero1 =  BigInt(100);
    /*console.log(typeof numero1);*/

La solución la encontrarás aquí: Haz click aquí.

Capítulos


Suscríbete a mi canal de YouTube para apoyarme

Si te ha gustado este curso y crees que el trabajo merece la pena, te agradeceré eternamente que te suscribas a mi canal de YouTube para apoyarme y que pueda seguir haciendo cursos gratuitos.

Además, si te encanta la programación, tienes un montón más de cursos gratuitos para ver.

No solo eso, podrás participar enviándome comentarios con tus sugerencias para temas específicos o cursos completos o incluso las dudas que tengas y las intentaré ir resolviendo en los cursos que estén todavía abiertos.


Comentarios

Si te quedan dudas sobre el temario, sobre JavaScript, o cualquier otra cosa relacionada o simplemente quieres agradecer, aquí tienes tu sitio para dejar tu granito de arena. Gracias por tus comentarios y por darle vida a este sitio web.