Os comentários do JavaScript são utilizados para documentar o código de uma forma geral. Você poderá utilizá-lo para documentar as rotinas,
avisos ou sugestões para que o usuário final possa interpretar o código facilmente. O comentário do JavaScript é ignorado pelo mecanismo
JavaScript, ou seja, incorporado ao navegador.
Vantagens dos comentários JavaScript:
Existem principalmente duas vantagens nos comentários do JavaScript:
- Para facilitar a compreensão do código. Ele pode ser usado para elaborar o código, para que o usuário final possa entendê-lo facilmente.
- Para evitar o código desnecessário. Também pode ser usado para evitar a execução do código. Às vezes, adicionamos o código para executar alguma ação. Mas, depois de algum tempo, pode ser necessário desativar o código. Nesse caso, é melhor usar comentários.
Tipos de comentários de JavaScript:
Existem dois tipos de comentários em JavaScript.
- Comentário de linha única.
- Comentário de várias linhas.
Comentário JavaScript de linha única:
É representado por barras duplas (//). Pode ser usado antes e depois da declaração.
Vamos ver o exemplo de comentário de linha única, ou seja, adicionado antes da declaração.
Vejamos agora um exemplo de comentário de linha única adicionado após a declaração.
Comentário de Múltiplas Linhas
Ele pode ser usado para adicionar comentários únicos e de várias linhas. Então, é mais conveniente. É representado por barra com asterisco
(/*) no início e asterisco com barra (*/) no final.
Por exemplo:
/* seu código aqui */
Pode ser usado antes, depois e no meio da declaração.
Vejamos um exemplo:
*****
|