Comentários HTML, cuidado com o que você comenta!

Leitura de 2 minutos

Em qualquer ambiente que você esteja, seja ele online ou físico, temos que ponderar, mediar e prestar muita atenção no que falamos e principalmente quando escrevemos. A linguagem escrita merece uma atenção especial, pois, com simples busca ao Google conseguimos ver muita coisa. Neste artigo chamo atenção para aos comentários nas linguagens de programação, em especial os comentários em HTML.

Para aqueles que desconhecem o que é um comentário, comentário é um trecho de texto delimitado por algum caractere utilizado nas linguagens de programação, onde seu objetivo principal é explicar o que faz aquele trecho de código, e deixar notas para consultas posteriores, uma vez que essas anotações não são processadas. Abaixo você pode ver exemplos nas principais linguagens utilizada para criação de sites.

O HTML e CSS, linguagens de marcação e apresentação respectivamente possuem uma estrutura de comentários bem simples.

Comentário HTML

<!- – Este é um exemplo de comentário em HTML – ->

Comentário CSS

/* Isto é um comentário em CSS */

Algumas linguagens de programação tendem a ter dois tipo de comentários, os comentários de uma linha e comentários para múltiplas linhas.

Comentário PHP

//Comentário de uma unica linha, utilizado para pequenas observações.

/*
Comentário de múltiplas linhas utilizado para delimitar
várias linhas de comentário.
Comentário escrito por Raphael Figa
*/

Comentário JavaScript

/*
Função deste arquivo: Fazer os efeitos de FadeIn e FadeOut nas box do site
Criado por Raphael Figa, em 20 de março de 2011
*/

Cuidado com o que você escreve!

Escrever na internet é muito semelhante a escrever em uma pedra, pois, fica gravado de tal forma que dependendo do ambiente onde você deixou suas marcas dificilmente poderá apagar. Em todas as linguagens os comentários são muito úteis pois ajudam a organizar o código e fazer anotações extras que com tempo naturalmente você irá esquecer.

Programar exige de qualquer profissional grande capacidade de concentração, e o trabalho em equipe pode tornar esta tarefa um pouco complicado, uma vez que a interação entre a equipe e concentração profunda são momentos bastante distintos.

Um comportamento a ser alertado surge quando os comentários perdem a função de explicar código e tornam-se pequenas anedotas falando de pessoas ou colegas de trabalho. Justamente neste ponto que o perigo se esconde, num primeiro cenário os comentário foram escritos em uma linguagem do tipo server-side como o PHP, onde qualquer individuo da equipe pode acessar e se deparar com brincadeiras de mal gosto, ofensas ou qualquer outra coisa do gênero. Nas linguagens client-side como HTML, CSS, ou JavaScript, o problema é maior pois além de ficar visíveis aos profissionais da equipe, ficam acessíveis a qualquer pessoas que tenham um pouco de curiosidade  e solicite ao navegador para visualizar o código fonte da página.

Então quando for pensar em comentar qualquer assunto que não esteja diretamente ligado ao trecho de código, preste muita atenção no que for escrever.