Comentário no HTML ainda é um tabu e difícil de encontrar em projetos grandes ou pequenos, entenderemos hoje a importância e porque e como devemos comentar nossos códigos, além de claro ver como não fazer um comentário HTML.

O que é um comentário HTML?

Além de uma boa prática é um trecho ou um texto que você coloca no seu código HTML para, no futuro entender como ele foi organizado, facilitando assim a manutenção do seu código-fonte.

Como fazer um comentário em HTML?

Fazer um comentário em HTML é bem simples e através dele podemos escrever uma linha ou até mesmo um bloco explicativo, veja exemplos de comentário HTML:

<!-- comentário de uma linha -->

<!--

Comentário de várias linhas,

pois as vezes é necessário uma explicação um pouco maior

-->

</div> <!--Comentário no final do HTML -->

Observe os exemplos veja que em todos iniciamos nossos comentários com <!– e, depois de escrever nosso comentário finalizamos o comentário com –>, e com esta simples sintaxe podemos facilmente documentar nosso código.

Porque utilizar comentários HTML?

Bom, a este momento já deve parecer óbvio o motivo de utilizarmos um comentário, mas creio que somente com a experiência podemos saber a diferença entre um código comentado e um não comentado, por exemplo, vamos supor que seu site seja dividido em três  partes sendo estas cabeçalho, conteúdo e rodapé. e seu código inicial fique mais ou menos assim:

<div id="main">
   <div id="cabecalho">

   </div>

   <div id="content">

   </div>

   <div id="rodape">

   </div>

</div>

A principio deve parecer simples identificar o inicio e o fim de cada elemento, porém, conforme nosso código for crescendo, será cada vez mais difícil saber qual </div> esta fechando o <div id=”conteudo”> por exemplo. Para facilitar esta identificação faremos da seguinte maneira:

<div id="main">
   <div id="cabecalho">

   </div> <!-- FIM cabeçalho -->

   <div id="content">

   </div> <!-- FIM content -->

   <div id="rodape">

   </div> <!-- FIM rodape -->

</div> <!-- FIM Main -->

Com isso saberemos aonde exatamente cada bloco se encerra, tornando mais fácil a manutenção deste código.

Porque não utilizamos comentários no HTML?

Infelizmente alguns desenvolvedores enumeram mais motivos para não utilizarmos comentários no HTML do que para utilizarmos e isso é realmente triste, mas não deixa de ter um fundo de razão, explico.

O comentário HTML, assim como todo o código-fonte é enviado para o navegador do seu usuário, ocasionando assim um aumento no tamanho do arquivo que o usuário terá de baixar e por consquência deixar o acesso ao seu site mais lento.

Isto pode ser verdade, por isso defendo sempre a utilização de um comentário simples e direto e mais auto-explicativo possível, além da não utilização deste recurso para comentar blocos que não são mais utilizados na exibição, sendo assim necessário um aprovisionamento destes comentários para termos certeza que não serão excessivos ao ponto de atrapalhar o usuário.

Portanto, use com moderação.


10 Comments

  1. EVERTON
    Posted 12 de outubro de 2012 at 13:05 | Permalink

    OII COMO VAI VOCE

  2. EVERTON
    Posted 12 de outubro de 2012 at 13:05 | Permalink

    OII COMO VAI VOCE

  3. Erick Thomé
    Posted 5 de novembro de 2012 at 08:59 | Permalink

    Muito bom o artigo, está de parabéns.

  4. Erick Thomé
    Posted 5 de novembro de 2012 at 08:59 | Permalink

    Muito bom o artigo, está de parabéns.

  5. Marisa Martins Hadrich
    Posted 21 de dezembro de 2012 at 20:43 | Permalink

    Não consigo mais fazer comentários em blogs, pelo IPad. Até semana passada não havia nenhum problema, independente da formatação.

  6. Marisa Martins Hadrich
    Posted 21 de dezembro de 2012 at 20:43 | Permalink

    Não consigo mais fazer comentários em blogs, pelo IPad. Até semana passada não havia nenhum problema, independente da formatação.

  7. Israel
    Posted 15 de janeiro de 2013 at 19:53 | Permalink

    Como estou começando a utilizar o HTML fico meio perdido no decorrer dos códigos. Aprender a utilizar comentários faz muita diferença. Principalmente tendo em mente que eles fazem diferença no tamanho do arquivo. Obrigado pelas dicas!

  8. Israel
    Posted 15 de janeiro de 2013 at 19:53 | Permalink

    Como estou começando a utilizar o HTML fico meio perdido no decorrer dos códigos. Aprender a utilizar comentários faz muita diferença. Principalmente tendo em mente que eles fazem diferença no tamanho do arquivo. Obrigado pelas dicas!

Deixe uma resposta

O seu endereço de email não será publicado Campos obrigatórios são marcados *

Você pode usar estas tags e atributos de HTML: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>