O comentário em um código HTML é um recurso que ajuda tanto o desenvolvedor que escreveu o código, quanto quem possa a vir trabalhar com esse mesmo código mais tarde.
O comentário em HTML não aparece no resultado do navegador e não tem qualquer interferência no código. Trata-se de um recurso que permite ao desenvolvedor realizar anotações que considere importantes sem a necessidade de criar um documento de texto para esse fim, além de contribuir para a organização do código.
Como criar comentário em HTML
Para inserir um comentário em HTML, basta usar a tag <!– –>
Exemplo:
<!DOCTYPE html>
<html lang=”pt-br”>
<head>
<metacharset=”UTF-8″>
<metahttp-equiv=”X-UA-Compatible”content=”IE=edge”> <metaname=”viewport”content=”width=device-width, initial-scale=1.0″> <linkrel=”shortcut icon”href=”favicon.ico”type=”image/x-icon”> <title>Comentário em html</title>
</head>
<body>
<h1>Parágrafos e quebras de linha</h1>
<!–A tag hr é utilizada para criar uma linha horizontal–>
<hr>
<!–< e > retornam < e > respectivamente–>
<p>Você pode escrever um parágrafo de qualquer jeito, basta colocar tudo no meio do par de tags <p> e </p></p>
<!–A tag br é utilizada para quebrar linhas–>
<p>Se precisar quebrar a linha em <br>algum lugar, use a tag <br></p></body></html Observe que o comentário é escrito dentro da tag <!– comentário –>.
Mais curiosidades:
Além de explicar o que determinadas partes do código fazem, a tag de comentário também pode ser utilizada para outros fins, como desabilitar partes de um código para fins de testes. Também podemos utilizar a tag de comentário para que scripts não suportados sejam ignorados pelo navegador. Para isso, utilizamos barra dupla (//) antes do fechamento da tag.
Exemplo:
<!– <script>
var str = ‘Terminal Root’;
if(str.match(/Root/)){
document.write(‘Encontrou’);
}else{
document.write(‘Palavra Não Encontrada’);
}
</script> //–>
Observações:
– É muito importante lembrar de abrir e fechar a tag de comentário corretamente. Caso você esqueça de algum elemento que a compõe, o navegador não interpretará a linha como um comentário e isso pode causar danos no resultado do código.
– Nunca esqueça de fechar a tag de comentário, caso contrário, o código inteiro pode se transformar em um gigantesco comentário e não reproduzirá resultados no navegador. Alguns editores de código, como o VS Code, já fecham as tags de forma automática, evitando esquecimentos e falhas que podem inutilizar o funcionamento do código.
E aí? Gostou da dica?
Já utiliza esse recurso em seus códigos HTML