A marcação HTML corretamente comentada é uma parte importante de uma página da Web bem construída. Esses comentários são fáceis de adicionar, e qualquer um que tenha que trabalhar no código do site no futuro (incluindo você ou membros de qualquer equipe com quem você trabalha) agradecerá por esses comentários.
Como adicionar comentários HTML
O HTML pode ser criado com um editor de texto padrão, como o Notepad ++ for Windows ou o TextEdit para um Mac. Você também pode usar um programa centrado em design da Web, como o Adobe Dreamweaver ou até mesmo uma plataforma CMS, como o Wordpress ou o ExpressionEngine. Independentemente da ferramenta usada para criar HTML, se você estiver trabalhando diretamente com o código, adicione comentários HTML como este:
-
Adicione a primeira parte da tag de comentário HTML:
-
Então, no total, seu comentário será algo como isto:
-
É tão simples assim.
A exibição de comentários
Quaisquer comentários que você adicionar ao seu código HTML aparecerão nesse código quando alguém visualizar a origem da página da Web ou abrir o HTML em um editor para fazer algumas alterações. Esse texto de comentário, no entanto, não aparecerá no navegador da Web quando um visitante normal acessar o site. Ao contrário de outros elementos HTML, incluindo parágrafos, cabeçalhos ou listas, que realmente afetam a página dentro desses navegadores, os comentários são realmente partes "de bastidores" da página.
Comentários para fins de teste
Como os comentários não aparecem em um navegador da Web, eles podem ser usados para "desativar" partes de uma página durante o teste ou desenvolvimento da página. Se você adicionar a parte de abertura de um comentário diretamente antes da parte de sua página / código que deseja ocultar e, em seguida, adicionar a parte de fechamento no final desse código (os comentários HTML podem abranger várias linhas, para que você possa abrir comentar na linha 50 do seu código e fechá-lo na linha 75 sem problemas), então quaisquer elementos HTML que caibam nesse comentário não serão mais exibidos no navegador. Eles permanecerão no seu código, mas não afetarão a exibição visual da página. Se você precisar testar uma página para ver se uma determinada seção está causando problemas, etc., é recomendável excluí-la comentando essa área. Com os comentários, se a seção do código em questão não for o problema, você poderá remover facilmente as partes do comentário e esse código será exibido novamente. Apenas certifique-se de que esses comentários usados para teste não sejam incluídos em sites de produção.
Se uma área de uma página não deve ser exibida, você deseja remover o código e não apenas comentá-lo antes de iniciar o site.
Um grande uso de comentários HTML durante o desenvolvimento é quando você está criando um site responsivo. Como diferentes partes desse site alteram sua aparência com base em diferentes tamanhos de tela, incluindo algumas áreas que podem não ser exibidas, o uso de comentários para ativar ou desativar seções de uma página pode ser um truque rápido e fácil de usar durante o desenvolvimento.
Em relação ao desempenho
Já vi alguns profissionais da Web sugerirem que os comentários devem ser removidos dos arquivos HTML e CSS para reduzir o tamanho desses arquivos e criar páginas com carregamento mais rápido. Embora eu concorde que as páginas devem ser otimizadas para desempenho e devem ser carregadas rapidamente, ainda há espaço para o uso inteligente de comentários no código. Lembre-se de que esses comentários destinam-se a facilitar o trabalho em um site no futuro, contanto que você não o exija com comentários adicionados a todas as linhas de seu código, a pequena quantidade de tamanho de arquivo adicionada a uma página devido a os comentários devem ser mais do que aceitáveis.
Dicas para usar comentários
Algumas coisas a serem lembradas ou lembradas ao usar comentários HTML:
- Comentários podem ser múltiplas linhas.
- Use comentários para documentar o desenvolvimento da sua página.
- Os comentários também podem documentar conteúdo, linhas ou colunas da tabela, acompanhar alterações ou o que você quiser.
- Os comentários de que as áreas de "desativação" de um site não devem entrar em produção, a menos que essa alteração seja temporária e que seja revertida em curto prazo (como se uma mensagem de alerta fosse ativada ou desativada conforme necessário).
