Como escrever comentários no código JavaScript

Comentários são notas de que um programador sai em seu código para torná -lo mais compreensível. A maioria dos desenvolvedores seniores se concentra no código de escrita, que é eficiente e pode ser facilmente lido e interpretado por computadores. No entanto, é de igual importância tornar o código facilmente legível para as pessoas (que estarão trabalhando com o código no futuro) também. Um programador deve saber como estruturar corretamente o código para torná -lo mais compreensível para os humanos.

O que são comentários?

Os comentários podem ser qualquer coisa, desde uma explicação de linha única até a descrição de várias linhas do código que é escrito dentro do código-fonte de um programa. Eles geralmente são usados ​​para deixar notas nas partes complexas do código -fonte, para que qualquer pessoa que olhe para o código no futuro possa entender facilmente o objetivo desse pedaço de código. Essa prática economiza tempo, pois qualquer um pode entender facilmente o objetivo do código sem fazer nenhum esforço.

Agora, vamos começar a aprender a estruturar corretamente o código -fonte JavaScript escrevendo diferentes tipos de comentários:

Tipos de comentários em javascript

JavaScript tem dois tipos principais de comentários:

• Comentários de linha única.
• Comentários de várias linhas

Comentários de linha única: Em JavaScript, duas barras para a frente (//) são usadas para escrever comentários de linha única:

// Um ​​comentário de linha única

Os comentários em qualquer linguagem de programação não têm efeito no programa real. Os intérpretes/compiladores das linguagens de programação são projetados de uma maneira que ignoram todos os comentários ao interpretar/compilar um programa.

Os comentários podem ter suas próprias linhas separadas; Eles também podem ser adicionados em linha com outro código também.

Comentários embutidos: Quando os comentários de linha única são usados ​​na mesma linha que o código, eles são chamados de comentários embutidos:

deixe um = 30; // Um ​​comentário em linha
Seja b = a + 10; // adicionando 10 em "A" variável e atribuindo -a a "B"

Os comentários em linha são usados ​​para explicar a linha exata de código em que estão escritos; Eles podem ser usados ​​para uma descrição específica e pequena do código presente nessa linha.

Comentários de várias linhas: Em JavaScript, os comentários do bloco, os comentários de várias linhas são escritos da mesma maneira que são escritos no CSS com tags de abertura (/*) e tags de fechamento (*/):

/* Um bloco
Comente*/

Todo o texto entre as tags de abertura e fechamento é ignorado pelos intérpretes.

Comentários de várias linhas ou comentários no nível do bloco são usados ​​para explicar e dar uma descrição detalhada de uma seção de código. Esse tipo de comentário geralmente é colocado na parte superior do arquivo de código -fonte ou antes de um bloco de código particularmente complexo:

/* Buscando o nome do usuário
De um campo de entrada
e mostrando no console */
função showUser ()
const nome = documento.getElementById ('nome do usuário');
console.log ("Olá e bem -vindo ao Linuxhint.com, " + nome +".");

showUser ();

Comentando código para testes/depuração: Os comentários podem ser usados ​​para impedir de maneira rápida e fácil a execução de um código de bloco; Tantos desenvolvedores de javascript seniores também usam comentários para fins de teste e depuração. Colocar as etiquetas de comentários atrás de um bloco de código para que seja ignorado pelo intérprete e não seja executado é referido como "Comentando código".

Comentar o código ajuda a identificar a causa de um erro no código. Eles também podem ser usados ​​para testar diferentes blocos de código para obter resultados diferentes:

// Função para dividir dois números
Divisão de funções (dividendo, divisor)
Deixe o quociente = dividendo / divisor;
quociente de retorno;

// função para subtrair dois números
Subtração de função (num1, num2)
deixe sub = num1 - num2;
retornar sub;

/* Na seguinte linha de código, estamos comentando a chamada de função da função da divisão. Portanto, apenas a função subtração () será chamada e executada. */
// divisão (30, 5);
multiplicanos (9, 3);

Práticas para escrever um bom código JavaScript

Aqui discutiremos as três práticas recomendadas para escrever um bom código JavaScript:

Os comentários geralmente são escritos acima do bloco de código que estão explicando:

// mostra "Olá, Linuxhint!"No console
console.log ("Olá, Linuxhint!");

Comentários de recuo no mesmo nível do código imediatamente abaixo deles:

// Definição da função
função showUser ()
// buscando o nome do usuário
const nome = documento.getElementById ('nome do usuário');
// imprima a mensagem no console
console.log ("Olá e bem -vindo ao Linuxhint.com, " + nome +".");

Lembre -se de que não há como encerrar os comentários em linha; Portanto, eles devem ser escritos somente após o código que essa linha foi escrito completamente:

para (vamos i = 0; i === 10; i ++) // para um loop que roda dez vezes
// A execução deste código resulta em um erro de sintaxe

Conclusão

Quantas vezes você resolveu um problema complexo escrevendo algum código apenas para voltar alguns meses depois e descobrir que você se lembra e não entende nada? Comentários ajudam a evitar isso escrevendo explicações/descrições detalhadas do seu código. Eles também ajudam a depurar testes e identificar a fonte de erros em seu código. Comentários únicos e multilinas podem ser usados ​​para fins de depuração/teste. Se você é um Dev Javascript para iniciantes, escreva o maior número possível de comentários em seu código para que eles sejam necessários para compreender o código que você escreve; Mas lembre -se de que eles só devem ser adicionados onde são necessários.