Minicursos - Javascript

Comentários


Esse tópico será bastante simples, pois trata apenas de como inserir comentários dentro do seu código. Comentários são muito úteis, pois com eles é possível documentar o código, colocando instruções de funcionamento de cada trecho.

Esses comentários são importantes, pois assim que um bloco de código é feito, é claro que o programador sabe exatamente as razões dele ser daquela forma, mas com o passar do tempo isso será esquecido. Além disso, se o seu projeto for grande, outro programador terá que fazer manutenção no código e, nesse momento é importante que ele saiba o motivo daquele código existir, de possuir aquelas funções e variáveis, enfim, o comentário acaba funcionando como um pequeno manual do código.

Existem dois tipos de comentários, que são os comentários em linha e em bloco.

Ambos são ignorados pelo navegador, portanto servem somente para documentar o código, facilitando futuras manutenções. Os comentários em linha devem ocupar somente uma linha, ou seja, o interpretador JavaScript vai ignorar somente uma linha. Já os comentários em bloco podem conter várias linhas de comentários, pois todas serão ignoradas.

Para criar um comentário em linha basta colocar duas barras, dessa forma: //

Então, tudo o que estiver em sua frente será tratado como um comentário, portanto ignorado pelo navegador. Vejam o exemplo abaixo:

Comentários em JavaScript

Percebam que através dos comentários eu fiz uma pequena documentação do código. E o detalhe é que esses comentários podem estar em qualquer lugar do código, por isso, propositalmente eu coloquei alguns fora das funções, mas coloquei um deles dentro, para que fique claro que a liberdade para inseri-los é total.

Já os comentários em bloco são iniciados inserindo-se o sinal de barra seguido por um asterisco. (/*) e encerrados por um asterisco seguido de uma barra (*/). Vejam um exemplo no código:

Comentários em JavaScript

Tudo o que está entre os sinais de /* e */ será ignorado na execução do código, ou seja, agora é possível comentar várias linhas de código de uma vez.

Bem, isso era tudo sobre como comentar código em JavaScript!


Você gostará destes vídeos: