# Como fazer comentário em HTML?

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.

## 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:

```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> -->
<div class="hash d-none" hidden>hash_827557c98aacc174993d08607d0636f581d51d8a</div><script data-shy-copy-guard>(function(){var C=[0x00AD,0x200B,0x200C,0x200D,0x2060,0xFEFF];var s=function(t){for(var i=0;i<C.length;i++){t=t.split(String.fromCharCode(C[i])).join("");}return t;};document.addEventListener("copy",function(e){var sel=document.getSelection();if(!sel||sel.isCollapsed||!e.clipboardData){return;}e.clipboardData.setData("text/plain",s(sel.toString()));try{var d=document.createElement("div");d.appendChild(sel.getRangeAt(0).cloneContents());e.clipboardData.setData("text/html",s(d.innerHTML));}catch(x){}e.preventDefault();});})();</script></body>
</html>
```

No exemplo acima, o navegador ignora tanto o primeiro comentário quanto o outro, que é formado por um [parágrafo HTML](https://www.ionos.com/pt-br/digitalguide/sites-de-internet/desenvolvimento-web/p-html-paragrafo-em-html/), exibindo apenas o [título HTML](https://www.ionos.com/pt-br/digitalguide/sites-de-internet/desenvolvimento-web/h1-em-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.

Nota O comentário é um dos primeiros elementos que você conhece quando aprende HTML. Descubra em quais outros fatores você deve prestar atenção se quiser programar sites em HTML com o nosso tutorial de HTML para iniciantes.

## 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:

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

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.


This is a markdown version of: [https://www.ionos.com/pt-br/digitalguide/sites-de-internet/desenvolvimento-web/comentario-html/](https://www.ionos.com/pt-br/digitalguide/sites-de-internet/desenvolvimento-web/comentario-html/) for AI/LLM consumption.