Comentário Javascript

| | | | | | | | | | | | | | | | | | | |

Comentários JavaScript são usados para escrever notas no código ou para desabilitar seções de código sem excluí-las. Os comentários são feitos em JavaScript anexando // antes de uma única linha ou / * antes e * / depois de várias linhas.

Comentando código é uma característica fundamental de muitas linguagens de programação. A ideia por trás dos comentários de código é que, embora seu código seja lido pelo computador, seu código também será lido por humanos, por isso é importante que seja fácil para as pessoas entenderem o código que você escreve.

Os comentários permitem para acompanhar seu código durante a programação e dar a você a oportunidade de fazer anotações que podem ser úteis no futuro. Além disso, se você estiver trabalhando em equipe, escrever comentários ajudará a garantir que seu código seja legível para qualquer pessoa que precise contribuir com seu trabalho.

Neste tutorial, discutiremos como escrever comentários em JavaScript. Começaremos discutindo o valor dos comentários em JavaScript e, em seguida, daremos uma olhada na sintaxe que você pode usar para escrever comentários em JavaScript.

Comentários escrevendo sobre código

Sobre o assunto é uma parte essencial da escrita de código legível e gerenciável. A verdade é que, se você puder entender o código que está escrevendo hoje, não há garantia de que será capaz de descrever efetivamente o que ele faz amanhã. Além disso, se você estiver trabalhando com outras pessoas, é muito provável que elas não entendam parte do código que você está escrevendo.

é aí que entram os comentários. Comentários são declarações que são ignoradas pelo compilador e pode ser usado para explicar seu código JavaScript.

Como desenvolvedor, escrever comentários em seu código permitirá que você acompanhe com mais eficiência o que está fazendo. Ao escrever seu código, você pode escrever notas que o ajudarão a entender melhor seu código e entender a intenção por trás do código que você escreveu anteriormente. Escrever comentários também será útil para outras pessoas que possam ver seu código, pois o comentário provavelmente os ajudará a entender como seu código funciona com mais profundidade.

Cada desenvolvedor escreve comentários de forma diferente, mas a regra geral é que os comentários devem ser usados para explicar a intenção por trás de seu código. Afinal, seu código fala por si mesmo, mas as razões para escrever o código de uma determinada maneira geralmente não. Portanto, escrevendo comentários, você pode explicar por que abordou um problema de uma certa maneira, o que torna mais fácil para você e outros entenderem como seu programa funciona mais tarde.

Comentários JavaScript

Existem dois tipos de comentários usados em JavaScript:. Comentários de linha única e comentários em bloco

Comentários de linha única são escritos usando duas barras (//) e são escritos em uma linha de código. Qualquer caractere após a declaração "//" será ignorado até o final da linha. Aqui está um exemplo de um comentário de linha única em JavaScript:

// Este é um bloco de comentário de linha

são escritos com a abertura e tags de fechamento e permitem que você escreva comentários como várias linhas. As tags de abertura e fechamento para comentários em bloco são:

comentários em bloco às vezes são chamados de comentários de várias linhas e se parecem com comentários CSS de várias linhas. Aqui está um exemplo de um comentário de bloco em JavaScript:

Todo o código entre nossas tags de abertura e fechamento será ignorado pelo compilador.

Qualquer tipo de comentário pode ser usado para explicar seu código e discutir a intenção por trás de sua código. Aqui está um exemplo de comentário para explicar uma declaração de variável básica:

// Declare variáveis "chocolate" para armazenar tipos de chocolate como um array

var chocolate = [` Dark ` ,` Milk `,` White `,` hazelnuts`, `Caramel`];

Comentários em todas as linguagens de programação ‚Äã‚Äãdevem ser atualizados frequentemente conforme o código muda. Portanto, se decidimos que o nome da nossa variável será renomeado como "chocolate_types", precisamos atualizar nosso comentário para garantir que ele reflita o novo nome da variável. Na verdade, os programas ficam maiores, geralmente mudam significativamente, por isso é importante atualizar os comentários, bem como o código

Comentando os comentários do código

geralmente são usados para um de dois propósitos. a primeira, como discutimos neste artigo, é explicar a intenção por trás do seu código e esclarecer qualquer confusão. a segunda é impedir a execução de código durante o teste.

Comentar código permite interromper a execução de uma ou mais linhas de código sem remover completamente o código do programa. Comentar é comum durante a depuração, pois você pode tentar várias soluções para um problema e salvar o código para mais tarde

Aqui está um exemplo de comentário comentando uma linha de código.

Quando executarmos nosso programa, o compilador executará a linha de código que declara a variável Nós comentamos a "flavors" porque contém um erro e precisamos depurar o problema. Nesse caso, esquecemos de colocar um sinal de igual entre o nome da nossa variável ("flavors") e o valor da variável (nosso intervalo de sabores).

Detalhe cada um dos dois tipos de comentários que discutimos e explorar como eles podem ser usados.

comentários de linha única

comentários de linha única , também conhecidos como comentários embutidos, são usados para comentar parte de uma linha de código ou uma linha cheia de código. Aqui está um exemplo de um comentário JavaScript de linha única:

Neste comentário declaramos uma variável "first_type" que armazena o primeiro valor em nosso mesa "chocolate" . Em seguida, adicionaremos um comentário embutido no final de nossa linha para explicar a intenção por trás de nosso código.

Comentários de linha única são normalmente usados para fazer comentários breves sobre seu código ou para descrever a intenção por trás de um linha de código específica. No entanto, comentários de linha única não são o único tipo de comentário que você deve usar. Se você precisar explicar uma função maior, é melhor escrever comentários em bloco

comentários em massa

comentários em massa são escritos em várias linhas e são usados para explicar grande parte do código. Embora os comentários de uma única linha geralmente expliquem uma linha de código, um bloco de comentários pode explicar uma função ou a função de um arquivo.

multilinhas começam no início de uma função ou arquivo, na maioria Aqui está um exemplo de um comentário de bloco usado para explicar um loop:

Nosso comentário de bloco abrange t linhas de re e é usado para descrever o código escrito dez em nosso loop "for".

Os comentários de bloco também podem ser encontrados no início de um arquivo para explicar o propósito de um arquivo ou incluir informações sobre o autor e a versão do arquivo. Aqui está um exemplo de um snippet que inclui o autor de um arquivo e a data de criação em JavaScript:

Conclusão

Escrever comentários no código permite que você escreva em um código mais legível e de fácil manutenção. Você pode usar comentários para acompanhar seu código no futuro e para facilitar o entendimento de outras pessoas que trabalham com seu código.

Neste tutorial, discutimos o noções básicas de comentários e, em seguida, explorou como escrever um comentário JavaScript. Também discutimos os dois principais tipos de comentários - de linha única e de várias linhas - e mostramos exemplos de cada tipo de código de comentário em ação. Por fim, discutimos as diferenças entre comentários e comentários de código .

Agora você está pronto para escrever comentários em JavaScript como um especialista!