Comentários de código


Comentários em código JavaScript são anotações que têm o propósito de facilitar o entendimento de diferentes aspectos do código. Essas anotações são completamente ignoradas pelo motor JavaScript, responsável pela execução do código. Tanto o Node.js quanto o Google Chrome, por exemplo, compartilham o mesmo motor JavaScript.

Comentário de 1 linha

Para adicionar um comentário de uma única linha, utiliza-se // seguido do texto do comentário.

// Comentário
console.log("Olá");

Comentário de múltiplas linhas

Comentários de múltiplas linhas são inseridos entre /* e */. Tudo contido nesse bloco será tratado como um comentário.

/*
Bloco
de
comentário
*/

Tipo de comentário utilizado em documentação

Para documentar código de forma mais estruturada, pode-se utilizar o estilo de comentário que começa com /** e termina com */. Esse tipo de comentário é comumente usado em documentação de código.

/**
 * Título
 *
 * Descrição...
 */

Referências