Neste tutorial, você aprenderá sobre comentários JavaScript, por que deve usá-los e como usá-los com a ajuda de exemplos.
Comentários de JavaScript são dicas que um programador pode adicionar para tornar seu código mais fácil de ler e entender. Eles são completamente ignorados pelos motores JavaScript.
Existem duas maneiras de adicionar comentários ao código:
//- Comentários de linha única/* */- Comentários multilinhas
Comentários de linha única
Em JavaScript, qualquer linha que começa com //é um comentário de uma única linha. Por exemplo,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Aqui // printing name on the consoleestá um comentário.
Você também pode usar comentários de uma única linha como este:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Comentários multilinhas
Em Javascript, qualquer texto entre /*e */é um comentário de várias linhas. Por exemplo,
/* The following program contains the source code for a game called Baghchal. Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid. For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board. For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal. */
Visto que o resto do código-fonte será usado para implementar as regras do jogo, o comentário acima é um bom exemplo de onde você pode usar um comentário de várias linhas.
Usando comentários para depuração
Os comentários também podem ser usados para desabilitar o código para evitar que ele seja executado. Por exemplo,
console.log("some code"); console.log("Error code); console.log("other code");
Se você obtiver um erro ao executar o programa, em vez de remover o código sujeito a erros, pode usar comentários para impedi-lo de ser executado; esta pode ser uma ferramenta de depuração valiosa.
console.log("some code"); // console.log("Error code); console.log("other code");
Dica profissional: lembre - se do atalho para usar comentários; pode ser muito útil. Para a maioria dos editores de código, é Ctrl + /para Windows e Cmd + /Mac.
Torne o código mais fácil de entender
Como desenvolvedor de JavaScript, você não apenas escreverá código, mas também terá que modificar o código escrito por outros desenvolvedores.
Se você escrever comentários em seu código, será mais fácil entender o código no futuro. Além disso, será mais fácil para seus colegas desenvolvedores entenderem o código.
Como regra geral, use comentários para explicar por que você fez algo, em vez de como você fez algo, e você é bom.
Observação: os comentários não devem substituir uma maneira de explicar um código mal escrito em inglês. Você deve sempre escrever um código bem estruturado e autoexplicativo. E então use comentários.
