Um comentário HTML é uma seção de texto dentro de um documento HTML que será ignorada pelo navegador e não exibida pela página ou site. O recurso é usado para facilitar a compreensão de desenvolvedores, apresentar explicações e desativar partes do código temporariamente.

Hospedagem que se adapta às suas ambições
  • Fique online com 99,99% de tempo de atividade e segurança robusta
  • Aumente o desempenho com um clique à medida que o tráfego cresce
  • Inclui domínio gratuito, SSL, e-mail e suporte 24 horas por dia, 7 dias por semana

O que é comentário HTML e como adicioná-lo?

Comentário HTML é uma marcação especial que permite aos programadores inserir anotações no código. Tais anotações não são renderizadas pelos navegadores, por isso, permanecem invisíveis para os usuários finais. Para inserir um comentário em HTML, utilize a seguinte sintaxe: <!-- conteúdo do comentário -->. Veja abaixo um exemplo simples que mostra como inserir um comentário em um documento HTML:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Página de exemplo</title>
</head>
<body>
    <!-- Isso é um comentário. Ele não será exibido pelo navegador -->
    <h1>Olá, mundo!</h1>
    <!-- <p>Esse texto não é exibido pelo navegador.</p> -->
</body>
</html>
HTML

No exemplo acima, o navegador ignora tanto o primeiro comentário quanto o outro, que é formado por um parágrafo HTML, exibindo apenas o título HTML.

Não existe uma sintaxe específica para comentários de múltiplas linhas em HTML. Essa capacidade é especialmente útil em situações nas quais é necessário inserir explicações ou anotações mais longas. Os comentários com múltiplas linhas começam e terminam do mesmo jeito que os comentários de uma linha.

Para que serve um comentário HTML?

Um comentário HTML pode desempenhar funções essenciais no desenvolvimento web. Ele exerce diferentes papeis importantes, como:

  • Documentação: O comentário ajuda a documentar o código para que outros desenvolvedores (ou você mesmo, no futuro) entendam a finalidade e funcionalidade das seções do código mais facilmente.
  • Desativar o código: Programadores conseguem desativar temporariamente partes do código ou tags HTML sem ter que excluí-las. Esse recurso é especialmente útil para fazer depurações ou experimentos.
  • Organização: Grandes documentos HTML podem ser estruturados e organizados usando um comentário HTML, facilitando a navegação e a edição do código.
  • Anotações: Os desenvolvedores podem inserir anotações pessoais no código.

O que levar em consideração ao usar um comentário HTML?

Existem alguns pontos importantes aos quais os desenvolvedores devem se atentar quando trabalham com um comentário HTML. Por exemplo, não é permitido usar comentários aninhados. Isso significa que um comentário não pode ser inserido dentro de outro, caso contrário, ocorrerá um erro. Veja o exemplo abaixo:

<!--
    Isso é um comentário.
    <!-- Isso é um comentário aninhado que resulta em um erro. -->
-->
HTML

Ao escrever comentários, é fundamental seguir as melhores práticas. Eles devem ser claros e diretos para melhorar a legibilidade do código. Evite comentários excessivamente longos. Prefira explicações curtas e objetivas para manter o código legível. O ideal é que o código explique a si mesmo. Comentários são recursos valiosos, mas não devem ser usados como substitutos de códigos limpos e bem-estruturados.

Construa sua marca com um ótimo domínio
Registre um nome de domínio
  • SSL Wildcard grátis para mais segurança
  • Registro privado grátis para mais privacidade
  • Domain Connect grátis para configurar DNS fácil
Este artigo foi útil?
Ir para o menu principal