Comentário HTML: o que são, como usá-los e 3 boas práticas de uso
Comentários HTML: o que são, como usá-los e 3 boas práticas de uso
jul 23 - 3 min leitura
A linguagem de marcação HTML está em (quase) tudo. Ela foi e ainda é amplamente utilizada para fazer a internet tal qual conhecemos hoje.
Vimos aqui no blog como é a estrutura básica de uma página HTML e o quão importante é cada etapa para organizar o código e, assim, construir uma página na web do jeito que se quer.
Hoje vamos entender o uso dos comentários HTML na hora de se criar um site.
O que são comentários HTML?
São informações, dicas, avisos, conselhos, que só podem ser vistos dentro do código fonte, ou seja, não aparecem no navegador para os leitores.
Um comentário HTML é um espaço que o desenvolvedor tem para comunicar o que o código escrito está fazendo, como ele funciona e porque foi feito daquela forma. Logo, é possível fazer ajustes, aperfeiçoamentos e mudanças futuras nas páginas e de maneira mais rápida.
É possível inserir um comentário no meio do código desenvolvido, sem que interfira na compreensão e funcionamento do arquivo HTML, pois os navegadores não os interpretam como informações visíveis ao usuário.
Como incluir comentários HTML no código?
É muito simples incluir comentários no código HTML. Inicia-se um comentário com <!– e se termina com –>.
Os comentários podem ter muitas ou apenas uma linha. Tudo o que for digitado depois da tag <!– será interpretado como comentário, inclusive quebra de linha.
Quando um –> é encontrado, o comentário acaba. Veja exemplo:
<h1>Esse título será interpretado e aparecerá no navegador</h1>
<!– Isso é um comentário e será ignorado. –>
<!– Isso é um comentário de
mais de uma linha e será ignorado–>
<p>Esse parágrafo será interpretado</p>
Quais os tipos de comentários HTML?
Como já dito, são muitas as finalidades de se colocar comentários HTML. Eles são úteis para:
Registrar, alertar ou descrever o porquê daquela implementação, a fim de deixar mais legível para quem faz a manutenção ou edição do conteúdo da página;
É indicado utilizar ou não utilizar comentários HTML?
É indicado utilizar os comentários para o que for relevante sobre o parte do código de uma página, durante seu processo de criação.
No entanto, para deixar o código otimizado, é indicado excluir comentários excedentes ou não relevantes da versão final do documento. Assim, poupando espaço, ele ficará mais leve e organizado.
Dicas para o uso dos comentários no código:
Cuidado com comentários que indicam erro no código: eles servem para destacar um erro que precisa ser consertado, mas devem ser apagados assim que resolvido.
Altere os comentários que indicam o objetivo do código: é crucial que todas e quaisquer mudanças na função de um código sejam registradas para garantir que os demais envolvidos entendam o que aconteceu.
Utilize poucas palavras ao comentar o código: tudo que é escrito toma espaço (bits) que interferirá no tamanho do documento final, portanto, seja sucinto.
Como usar os comentários em outras linguagens de programação?
Todas as linguagens, de marcação ou de programação, oferecem o recurso dos comentários, mas cada uma tem sua sintaxe própria. Veja como comentar um código em outras linguagens:
Na linguagem CSS, os comentários começam com uma barra seguida de asterisco /* e termina fechando o comando com asterisco, seguido de barra */.
Nesta linguagem, podem ser feitos comentários de uma linha. Veja:
A linguagem CSS também suporta comentários multilinha, ou seja, aceita mais de uma linha. Tudo o que está compreendido entre a abertura e o fechamento é considerado comentário, por exemplo:
que pode ter várias linhas
Como incluir comentários em JavaScript?
O Javascript permite comentários de uma e também múltiplas linhas. Nessa linguagem, entretanto, os comentários de uma linha tem sintaxe diferente daqueles com várias.
De uma linha, faz-se com duas barras (//). Tudo o que vem depois dessas duas barras é considerado comentário pelo interpretador.
Para múltiplas linhas, a sintaxe é a mesma do CSS: /* para iniciar o comentário e */ para terminar.
Vale lembrar que ambas as linguagens exigem que o programador feche o comentário, ou seja, termine com */.
Ter uma estrutura de código comentada é uma ótima prática dentro da programação e importante ferramenta para o desenvolvimento de código.
Mas lembre-se: faça comentários claros e diretos! Deste modo, o código será compreensível e de fácil leitura, agregando valor ao sistema final e facilitando sua manutenção.