Quando você visualiza uma página da Web em um navegador, está vendo uma representação visual do que essa parte do software (o navegador da Web) está exibindo com base no código de uma determinada página da Web. Se você visualizar esse código-fonte da página da Web, verá um documento composto de vários elementos HTML, incluindo parágrafos, cabeçalhos, listas, links, imagens e muito mais. Todos esses elementos são processados pelo navegador na tela de um visitante como parte da exibição do site. Uma coisa que você pode encontrar no código HTML que não é processado na tela de uma pessoa é o que é conhecido como "comentários HTML".
O que é um comentário?
Um comentário é uma cadeia de código dentro de HTML, XML ou CSS que não é visualizado ou usado pelo navegador ou analisador. Ele é simplesmente escrito no código para fornecer informações sobre esse código ou outro feedback dos desenvolvedores do código.
A maioria das linguagens de programação tem comentários, elas são comumente usadas pelo desenvolvedor do código por um ou mais de um, do seguinte motivo:
- Descreva e explique o código complicado para alguém que possa ter que trabalhar nele no futuro - incluindo eles mesmos! Eles podem voltar para o código 3 ou 6 de 12 meses ou mais depois e não lembrar por que fizeram algo de uma determinada maneira. Os comentários podem ajudar a responder às perguntas deles e lembrá-los de onde eles estavam quando começaram a desenvolver essa página.
- Forneça detalhes sobre quando o código foi editado ou revisado. Isso pode ser uma informação útil e agir como um log de desenvolvimento de quando um site foi trabalhado pela última vez.
- Remova seções do código, mas deixe-as disponíveis para uso posterior. Isso geralmente é feito durante o teste e a depuração do site. Se você tiver um problema em um site e não tiver certeza do que está causando isso, poderá comentar seções uma de cada vez para colocar em quarentena e identificar o problema e, em seguida, trabalhar em uma correção para os problemas que você está tendo.
- Converse com outros desenvolvedores trabalhando no código. Isso provavelmente seria feito durante o desenvolvimento como uma maneira de compartilhar detalhes com outras pessoas trabalhando no código ao mesmo tempo. Se esses comentários forem puramente conversas de desenvolvimento, é uma prática recomendada removê-los do código antes de um site ser lançado.
Tradicionalmente, comentários em HTML são usados para quase todos os elementos, desde explicações de estruturas de tabelas complexas até observações informativas do conteúdo da própria página. Como os comentários não são renderizados em um navegador, você pode adicioná-los em qualquer lugar no HTML e não se preocupar com o que ele fará quando o site for visualizado por um cliente.
Como escrever comentários
Escrever comentários em HTML, XHTML e XML é muito fácil. Simplesmente coloque o texto que você deseja comentar com o seguinte:
e
Como você pode ver, esses comentários começam com um "símbolo menor que", além de um ponto de exclamação e dois traços. O comentário termina com mais dois traços e um "maior que: símbolo. Entre esses caracteres você pode escrever o que quiser para compor o corpo do comentário.
Em CSS, é um pouco diferente, usando comentários de código C em vez de HTML. Você começa com uma barra seguida de um asterisco. Você termina o comentário com o inverso disso, um asterisco seguido por uma barra.
Comentários são arte morrendo
A maioria dos programadores sabe o valor de comentários úteis. O código comentado facilita a transferência desse código de um membro da equipe para outro. Os comentários ajudam a equipe de controle de qualidade a testar o código, pois eles podem dizer o que o desenvolvedor pretendeu - mesmo que não tenha sido alcançado. Infelizmente, com a popularidade de plataformas de criação de sites como o Wordpress, que permitem que você trabalhe com um tema escolhido que lida com muito, se não todo o HTML, os comentários não são usados com frequência pelas equipes da web. Isso ocorre porque os comentários são realmente difíceis de ver na maioria das ferramentas de criação visual, se você não estiver trabalhando diretamente com o código. Por exemplo, em vez de ver, no topo de uma página da Web:
A ferramenta visual mostra um pequeno ícone para indicar que um comentário está lá. Se o designer não abrir fisicamente o comentário, ele talvez nunca o veja. E no caso da página acima, pode causar problemas se ela editar a página e se a edição for sobrescrita pelo script mencionado no comentário.
O que pode ser feito?
- Escreva comentários úteis e significativos. Não espere que outras pessoas leiam seus comentários se forem muito longos ou não incluírem informações úteis.
- Como desenvolvedor, você deveria sempre revise os comentários que você vê em uma página.
- Use ferramentas fornecidas pelos programas de autoria que permitem adicionar comentários.
- Use o gerenciamento de conteúdo para controlar como as páginas são editadas.
Mesmo se você for a única pessoa que edita suas páginas da Web, os comentários podem ser úteis. Se você editar apenas uma página complicada uma vez por ano, é fácil esquecer como você criou a tabela ou montou o CSS. Com comentários, você não precisa se lembrar, como está escrito aqui para você.
