Comentários em JS

Comentários de JavaScript

Comentários de JavaScript podem ser usados para explicar o código JavaScript e torná-lo mais legível.

Os comentários de JavaScript também podem ser usados para evitar a execução, ao testar o código alternativo.

Comentários de linha única

Os comentários de uma única linha começam com //.

Qualquer texto entre //e o final da linha será ignorado pelo JavaScript (não será executado).

Este exemplo usa um comentário de uma única linha antes de cada linha de código:

Exemplo:

    // Change heading:
    document.getElementById("myH").innerHTML = "My First Page";

    // Change paragraph:
    document.getElementById("myP").innerHTML = "My first paragraph.";
    

Este exemplo usa um comentário de uma única linha no final de cada linha para explicar o código:

Exemplo:

      let x = 5;      // Declare x, give it the value of 5
      let y = x + 2;  // Declare y, give it the value of x + 2
    

Comentários multilinhas

Comentários multilinhas começam com /*e terminam com */.

Qualquer texto entre /*e */será ignorado pelo JavaScript.

Este exemplo usa um comentário de várias linhas (um bloco de comentário) para explicar o código:

Exemplo:

      /*
      The code below will change
      the heading with id = "myH"
      and the paragraph with id = "myP"
      in my web page:
      */
      document.getElementById("myH").innerHTML = "My First Page";
      document.getElementById("myP").innerHTML = "My first paragraph.";
    

Usando comentários para prevenir a execução

Usar comentários para evitar a execução de código é adequado para teste de código.

Adicionar //na frente de uma linha de código altera as linhas de código de uma linha executável para um comentário.

Este exemplo usa // para evitar a execução de uma das linhas de código:

Exemplo:

      //document.getElementById("myH").innerHTML = "My First Page";
      document.getElementById("myP").innerHTML = "My first paragraph.";
    

Este exemplo usa um bloco de comentário para evitar a execução de várias linhas:

Exemplo:

      /*
      document.getElementById("myH").innerHTML = "My First Page";
      document.getElementById("myP").innerHTML = "My first paragraph.";
      */
    

Fonte: w3schools