Comentários são trechos de texto inseridos no código HTML que não são exibidos para o usuário no navegador.
Eles servem para explicar partes do código, organizar estruturas e facilitar a manutenção de projetos.
Um comentário é uma anotação dentro do código que é ignorada pelo navegador durante a interpretação da página.
<!-- Este é um comentário HTML -->
O navegador lê o comentário, mas não apresenta esse conteúdo na tela.
Todo comentário HTML inicia com:
<!--
e termina com:
-->
<!--
Comentário
-->
<body>
<!-- Cabeçalho do site -->
<header>
Minha página Web
</header>
</body>
O comentário identifica a função daquela parte do código.
Em projetos profissionais, comentários são utilizados para separar grandes blocos de código.
<!-- =========================
MENU PRINCIPAL
========================= -->
<nav>
Menu do site
</nav>
<!-- =========================
CONTEÚDO PRINCIPAL
========================= -->
<main>
Conteúdo
</main>
Também podemos utilizar comentários dentro do CSS.
<style>
/*
Configuração do corpo
*/
body{
background: #ffffff;
}
</style>
JavaScript possui sua própria forma de comentários.
// Comentário de uma linha
/*
Comentário
de várias linhas
*/
| Benefício | Descrição |
|---|---|
| Organização | Facilita encontrar partes do código. |
| Manutenção | Ajuda alterações futuras. |
| Trabalho em equipe | Outros desenvolvedores entendem melhor. |
| Documentação | Registra informações importantes. |
<!doctype html>
<html>
<head>
<!-- Configurações da página -->
<title>
Meu Site
</title>
</head>
<body>
<!-- Área de navegação -->
<nav>
Menu
</nav>
<!-- Conteúdo principal -->
<main>
Conteúdo
</main>
</body>
</html>
Exemplos de informações que não devem estar em comentários: