Na programação, os comentários são linhas de texto que são escritas no código para fornecer informações adicionais sobre o código para outros desenvolvedores ou para você mesmo no futuro.

Os comentários não são executados pelo computador, são simplesmente ignorados.

Em JavaScript, existem duas maneiras de escrever comentários:

1. Comentários de linha única: Os comentários de linha única começam com duas barras (//) e continuam até o final da linha. Qualquer coisa escrita após as barras duplas é considerada um comentário.

Exemplo:

2. Comentários de várias linhas: Os comentários de várias linhas começam com uma barra seguida de um asterisco (/*) e terminam com um asterisco seguido de uma barra (*/). Qualquer coisa escrita entre esses símbolos é considerada um comentário.

Os comentários são úteis na programação porque permitem que você adicione notas ao seu código que explicam o que o código faz, por que ele faz isso e como funciona. Os comentários também facilitam a leitura e a compreensão do seu código por outros desenvolvedores. É uma boa prática adicionar comentários ao seu código, pois isso ajuda a tornar o código mais legível, fácil de manter e fácil de entender.

Cuidados

1. Se você acha que seu código precisa de muitos comentários, é um sinal de que seu código não é legível o suficiente. Com experiência e aprendizado de boas práticas, você será capaz de escrever código de fácil entendimento sem a necessidade de comentários.
2. Comentários muito longos podem tornar seu código difícil de ler. Tente manter seus comentários curtos e direto ao ponto. Se alguém precisar alterar seu código, provavelmente não atualizará os comentários também. Portanto, é melhor escrever um código fácil de entender sem a necessidade de comentários.
3. Se você precisar evitar mais um trecho de código, basta excluí-lo. Não há necessidade de comentá-lo. Se precisar mantê-lo por algum motivo, você pode usar um sistema de controle de versão como o Git para acompanhar as alterações em seu código.

Faça:

• Escreva comentários que expliquem o que o código faz, por que o faz ou como o faz.
• Use comentários para documentar código complexo, casos extremos ou quaisquer outros detalhes que possam não ser óbvios à primeira vista.
• Escreva comentários claros, concisos e fáceis de ler.
• Use formatação consistente para seus comentários, como começar com letra maiúscula e terminar com um ponto.
• Atualize seus comentários quando modificar seu código, para que permaneçam atualizados e úteis.

Não Faça:

• Não escreva comentários que simplesmente repitam o código ou descrevam o que já é óbvio.
• Não escreva comentários rudes ou pouco profissionais.
• Não escreva comentários que contenham informações sensíveis ou confidenciais.
• Não use comentários como substitutos de um código limpo e bem organizado.

Boas práticas:

• Use comentários para explicar o propósito de suas funções, variáveis e classes.
• Use comentários para documentar os parâmetros de suas funções e seu comportamento esperado.
• Use comentários para descrever quaisquer suposições ou restrições das quais seu código depende.
• Use comentários para fornecer links para documentação ou recursos externos.
• Use comentários para explicar quaisquer soluções alternativas ou correções temporárias que você implementou.
• Use um estilo consistente para seus comentários, como um formato ou sintaxe padrão.

Exercício

Arraste e solte as palavras para completar a frase corretamente.