Comentado apropriadamente HTML marcação é uma parte importante de uma página da web bem construída. Esses comentários são fáceis de adicionar e qualquer pessoa que tenha que trabalhar no código desse site no futuro (incluindo você ou membros de qualquer equipe com a qual você trabalhe) agradecerá por esses comentários.
Como adicionar comentários HTML
O HTML pode ser criado com um editor de texto padrão, como Notepad ++ para Windows ou TextEdit para Mac. Você também pode usar um programa centrado em web design como Adobe Dreamweaver ou até mesmo uma plataforma CMS como Wordpress ou ExpressionEngine. Independentemente da ferramenta que você usa para criar HTML, se estiver trabalhando diretamente com o código, adicione comentários de HTML como este:
Adicione a primeira parte da tag de comentário HTML:
Após a parte inicial do comentário, escreva qualquer texto que você gostaria que aparecesse para este comentário. É provável que sejam instruções para você ou outro desenvolvedor no futuro. Por exemplo, se você deseja designar onde uma determinada seção em uma página começa ou termina na marcação, você pode usar um comentário para detalhar isso.
Assim que o texto do seu comentário estiver completo, feche a tag de comentário desta forma:
Portanto, no total, seu comentário será mais ou menos assim:
É realmente simples assim.
A exibição de comentários
Todos os comentários que você adicionar ao seu código HTML aparecerão nesse código quando alguém vê o código-fonte da página da web ou abre o HTML em um editor para fazer algumas alterações. Esse texto de comentário, entretanto, não aparecerá no navegador da web quando visitantes normais vierem ao site. Ao contrário de outros elementos HTML, incluindo parágrafos, cabeçalhos ou listas, que realmente impactam a página dentro desses navegadores, os comentários são na verdade partes "nos 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 "desligar" 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 o fechar a parte no final desse código (comentários HTML podem abranger várias linhas, então você pode abrir um comentário na linha 50 de seu código e fechá-lo na linha 75 sem problemas), então quaisquer elementos HTML que caiam dentro desse comentário não serão mais exibidos no navegador. Eles permanecerão em 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., comentar essa área é preferível a excluí-la. Com os comentários, se a seção do código em questão provar não ser o problema, você pode remover facilmente as partes do comentário e o código será exibido novamente. Apenas certifique-se de que esses comentários usados para teste não cheguem aos sites de produção. Se uma área de uma página não deve ser exibida, você deseja remover o código, não apenas comentá-lo, antes de lançar o site.
Um ótimo uso de comentários HTML durante o desenvolvimento é quando você está construindo um site responsivo. Porque diferentes partes do site mudarão de aparência com base em diferentes tamanhos de tela, incluindo algumas áreas que podem não ser exibidas, usar 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.
Com relação ao desempenho
Tenho visto 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 de carregamento mais rápido. Embora eu concorde que as páginas devem ser otimizado para desempenho e deve carregar rapidamente, ainda há um lugar para o uso inteligente de comentários no código. Lembre-se de que esses comentários têm como objetivo facilitar o trabalho em um site no futuro, contanto que você não exagere com comentários adicionados a cada linha em seu código, a pequena quantidade de tamanho de arquivo adicionado a uma página devido aos comentários deve ser maior que aceitável.
Dicas para usar comentários
Algumas coisas a serem observadas ou lembradas ao usar comentários HTML:
- Os comentários podem ter várias linhas.
- Use comentários para documentar o desenvolvimento de sua página.
- Os comentários também podem documentar o conteúdo, linhas ou colunas da tabela, rastrear alterações ou o que você quiser.
- Comentários que "desligam" áreas de um site não devem entrar em produção, a menos que essa alteração seja uma temporário que será revertido em breve (como ter uma mensagem de alerta ligada ou desligada como necessário).