É correto usar comentários em HTML e CSS?
Publicado em 18.12.2005 na categoria Usabilidade
Já li em diversos artigos e textos sobre web standards que os desenvolvedores devem usar e abusar dos comentários nos arquivos HTML e CSS para uma melhor organização e facilidade de atualização.
À primeira vista, nada a discutir sobre isso. As marcações iniciadas com exclamação e asterisco no HTML e CSS existem justamente pra isso. A questão é: onde fica o usuário nisso tudo?
o usuário não precisa baixar bytes desnecessários
Se formos pensar, o usuário comum não irá fazer qualquer uso desses comentários. Então, por que ele deve ser obrigado a baixar alguns bytes a mais para algo que não vai ter nenhuma utilidade?
É fato que os comentários têm peso mínimo no tamanho total de um site. Na nova versão do Tableless, por exemplo, os autores decidiram deixar os arquivos de conteúdo e formatação bem comentados, para os usuários que gostam de estudar o código deles
Para efeito de teste, reuni os comentários em um único arquivo e o resultado foi 1,8 Kbytes a mais. Se contarmos somente o HTML, foi 1 KB para 17 KB do total do arquivo. Ou seja, quase 6%.
Claro que, neste caso específico, os comentários têm utilidade para o público-alvo do site. O que quero levantar aqui é a questão se devemos ou não utilizar os comentários nos projetos comuns, nos quais os usuário não têm o costume de ver o código fonte.
pelo tempo de resposta, cada byte deve ser pensado
Se formos pensar nos estudos da Nielsen Norman Group que apontam que o tempo de resposta ótimo seria de um décimo de segundo, cada KB de um arquivo deve ser pensado. Tudo o que for supérfluo, deve ser jogado fora para que a o tempo de resposta não passe dos 10 segundos, que seria o tempo máximo da capacidade humana de prestar atenção enquanto espera.
Por outro lado, se formos pensar na questão da organização e agilidade na hora de revisarmos um arquivo HTML ou CSS, os comentários são indispensáveis.
Pesei os dois pontos e cheguei a uma solução que me parece ser a mais justa com os desenvolvedores e os usuários. O desenvolvedor codifica os arquivos com os comentários adequados. Na hora de colocar no servidor, entretanto, duplica o arquivo e apaga os comentários. Assim, ele terá os arquivos comentados para revisões e atualizações e o usuário terá menos bytes para baixar a cada acesso ao site.
Você realmente acha que se preocupar com isso é necessário? Olha quantas pessoas ainda usam [font ....] e não tão nem aí… uns bytes a mais com comentários não fazem mal a ninguém…
Felipe, na verdade eu acho que o desenvolvedor deve se preocupar com absolutamente tudo que possa melhorar a experiência do usuário. É a melhor maneira para construir projetos que se destaquem na web. Quem usa font realmente está muito atrasado, mas não é por eles que devemos nos guiar.
Abraços e obrigado por comentar no blog.
Outro ponto a se considerar é a indentação do código. Se retirarmos todas as quebras de linha e tabulações, é possível reduzir enormamente um arquivo html ou css.
Uma coisa interessante é usar “find and replace” que a maioria dos editores possuem e junto com um regexp para filtrar os comentários. Infelizmente não sei utilizar regexp e nem achei nada neese sentido… :P
teste de envio
afafafafsfsa
Oi tudo bom Davi Achei lindo demais o seu site! Show de bola…Beijos…
Ass: Monica
Se pensarmos dessa forma algumas ferramentas de edição HTML (principalmente WYSIWYG) deveriam ser abolidas do planeta e proibidas de serem usadas, pois sujam muito mais o código do que uns meros comentários.
E mais, com a disseminação da banda larga no país, poucos se interessam por questões como consumo de banda por código “inútil”.
Vamos pensar também em algo como a necessidade de animações flash, áudio e outras coisas que alguns webdesigners usam para “melhorar” a aparência do seus sites, em detrimento de “detalhes” como usabilidade e adaptabilidade.
Os comentários não incomodam e não impedem a visualização e compressão das páginas, pelo contrário.
E mais, é preferível saber da sua existência a ignorar o que acontece por trás do engine de renderização dos browsers.
Imagina se o conteúdo das páginas fosse transportado a partir de código binário? Como poderíamos saber o que se passaria de um lado para outro na comunicação servidor browser?
Acho que existem páginas demais sem comentários, principalmente em trechos de scripts, que para alguns ainda se trata de linguagem alienígena. Nestes o comentário deveria ser obrigatório.
Olá… eu acho que existe um certo exagero nesta questão. Esquecemos que um site tem dua vertentes… uma: a dos desenvolvedores (talvez eu esteja usando mal a palavra… mas aqui quero dizer aqueles que produziram o site) e a outra que é o do usuário final.
Querer tirar os comentários do código de um site… muitas vezes equivale à querer tirar os itens de segurança de um carro. Ok… se tirarmos os cintos de seguranças… as travas… o extintor de incendio o carro gasta menos gasolina pois fica mais leve… mas e daí? cadê a segurança? Não vale a pena o motorista gastar algumas gotas a mais de gasolina e ter segurança?
Mas vc pode perguntar… aonde isso se encaixa na questão. Oras… muitas vezes, o desenvolvedor coloca os comentários para que possa se localizar dentro do código de um site um pouco mais complexo… ou mesmo para que (em caso de um grupo de trabalho) possam todos entender o que está sendo feito.
Vale a pena deixar de usar esse instrumento?
Fazer cópia dos arquivos? Isso só gera confusão… arquivos duplicados dores de cabeça.
Não acho serventia em poupar alguns poucos KB de um site. E estamos falando de muito poucos. Estas marcações podem ser muito úteis… só precisam ser bem utilizadas.
De resto este blog é muito bom e estou sempre aprendendo por aqui.