Os comentários JavaScript podem ser usados para explicar o código e torná-lo mais legível.
Comentários podem ser usados para impedir a execução de instruções no código durantes os testes de desenvolvimento.
Comentários de linha única
Os comentários de linha única começam com //.
Qualquer texto entre // e o final da linha será ignorado pelo interpretador.
Este exemplo usa um comentário de linha única antes de cada linha de código:
// mudando o cabeçalho
document.getElementById("meuCabecalho").innerHTML = "Meu primeiro cabeçalho";
// mudando o parágrafo
document.getElementById("meuParagrafo").innerHTML = "Meu Primeiro Parágrafo.";
O exemplo a seguir usa um único comentário no final de cada linha para explicar o código.
var x = 5; // Declare x, forneça o valor de 5
var y = x + 2; // Declare y, forneça o valor de x + 2
Comentários de várias linhas
Os comentários de várias linhas começam /* e terminam com */.
Qualquer texto entre /* e */ é ignorado pelo interpretador.
O exemplo a seguir usa um bloco de comentário com de várias linhas para explicar o código.
/*
O código abaixo mudará
o cabeçalho com id = "meuCabecalho"
e o parágrafo com id = "meuParagrafo"
na minha página da web.
*/
document.getElementById("meuCabecalho").innerHTML = "Meu primeiro cabeçalho.";
document.getElementById("meuParagrafo").innerHTML = "Meu Primeiro Parágrafo.";
É mais comum o uso de comentários curtos com uma única linha única.
Os comentários em bloco geralmente são usados para documentação formal.
Inibição de Código
O uso de comentários para impedir a execução do código é bastante utilizado para a realização de testes no 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.
O exemplo a seguir usa // para impedir a execução de uma das linhas de código.
//document.getElementById("myH").innerHTML = "Minha Primeira Página";
document.getElementById("myP").innerHTML = "Meu Primeiro Parágrafo.";
O exemplo a seguir usa um bloco de comentários para impedir a execução de várias linhas.
/*
document.getElementById("myH").innerHTML = "Minha Primeira Página";
document.getElementById("myP").innerHTML = "Meu Primeiro Parágrafo.";
*/