Um co­men­tá­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 com­pre­en­são de de­sen­vol­ve­do­res, apre­sen­tar ex­pli­ca­ções e desativar partes do código tem­po­ra­ri­a­mente.

Hos­pe­da­gem que se adapta às suas ambições
  • Fique online com 99,99% de tempo de atividade e segurança robusta
  • Aumente o de­sem­pe­nho 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 é co­men­tá­rio HTML e como adicioná-lo?

Co­men­tá­rio HTML é uma marcação especial que permite aos pro­gra­ma­do­res inserir anotações no código. Tais anotações não são ren­de­ri­za­das pelos na­ve­ga­do­res, por isso, per­ma­ne­cem in­vi­sí­veis para os usuários finais. Para inserir um co­men­tá­rio em HTML, utilize a seguinte sintaxe: <!-- conteúdo do comentário -->. Veja abaixo um exemplo simples que mostra como inserir um co­men­tá­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 co­men­tá­rio quanto o outro, que é formado por um parágrafo HTML, exibindo apenas o título HTML.

Não existe uma sintaxe es­pe­cí­fica para co­men­tá­rios de múltiplas linhas em HTML. Essa ca­pa­ci­dade é es­pe­ci­al­mente útil em situações nas quais é ne­ces­sá­rio inserir ex­pli­ca­ções ou anotações mais longas. Os co­men­tá­rios com múltiplas linhas começam e terminam do mesmo jeito que os co­men­tá­rios de uma linha.

Para que serve um co­men­tá­rio HTML?

Um co­men­tá­rio HTML pode de­sem­pe­nhar funções es­sen­ci­ais no de­sen­vol­vi­mento web. Ele exerce di­fe­ren­tes papeis im­por­tan­tes, como:

  • Do­cu­men­ta­ção: O co­men­tá­rio ajuda a do­cu­men­tar o código para que outros de­sen­vol­ve­do­res (ou você mesmo, no futuro) entendam a fi­na­li­dade e fun­ci­o­na­li­dade das seções do código mais fa­cil­mente.
  • Desativar o código: Pro­gra­ma­do­res conseguem desativar tem­po­ra­ri­a­mente partes do código ou tags HTML sem ter que excluí-las. Esse recurso é es­pe­ci­al­mente útil para fazer de­pu­ra­ções ou ex­pe­ri­men­tos.
  • Or­ga­ni­za­ção: Grandes do­cu­men­tos HTML podem ser es­tru­tu­ra­dos e or­ga­ni­za­dos usando um co­men­tá­rio HTML, fa­ci­li­tando a navegação e a edição do código.
  • Anotações: Os de­sen­vol­ve­do­res podem inserir anotações pessoais no código.

O que levar em con­si­de­ra­ção ao usar um co­men­tá­rio HTML?

Existem alguns pontos im­por­tan­tes aos quais os de­sen­vol­ve­do­res devem se atentar quando trabalham com um co­men­tá­rio HTML. Por exemplo, não é permitido usar co­men­tá­rios aninhados. Isso significa que um co­men­tá­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 co­men­tá­rios, é fun­da­men­tal seguir as melhores práticas. Eles devem ser claros e diretos para melhorar a le­gi­bi­li­dade do código. Evite co­men­tá­rios ex­ces­si­va­mente longos. Prefira ex­pli­ca­ções curtas e objetivas para manter o código legível. O ideal é que o código explique a si mesmo. Co­men­tá­rios são recursos valiosos, mas não devem ser usados como subs­ti­tu­tos de códigos limpos e bem-es­tru­tu­ra­dos.

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 pri­va­ci­dade
  • Domain Connect grátis para con­fi­gu­rar DNS fácil
Ir para o menu principal