Baixe em PDF Baixe em PDF

Comentar um código [1] HTML vai permitir reconhecer o funcionamento de cada parte dele posteriormente. O uso de comentários também serve para desativar temporariamente partes de código durante testes. Aprender a utilizar comentários de forma correta vai ajudar a criar códigos mais eficientes e de mais fácil compreensão tanto para você quanto para outros desenvolvedores.

  1. Comentários devem ser escritos entre as tags <!-- e --> . Utilize comentários curtos para identificar e explicar o funcionamento das partes do seu código.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    Título da página </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     <!-- Este é um comentário --> 
     < 
     p 
     > 
    Este é um parágrafo de texto </ 
     p 
     > 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
    • Não coloque espaços entre os caracteres da tag de comentários. Por exemplo, se você escrever < !-- , a função comentário não será ativada. Entre as tags , porém, você pode usar quantos espaços quiser.
  2. Seus comentários podem conter quantas linhas for preciso. Utilize comentários longos para explicar partes mais complexas do código ou mesmo para desativar porções grandes do código.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    Título da página </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     <!-- 
     O comentário pode ter o tamanho que você desejar. 
     Todo o texto contido entre as ''tags'' de comentário. 
     não afetará o código da página. 
     --> 
     < 
     p 
     > 
    Este é um parágrafo de texto </ 
     p 
     > 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
  3. Se você está tentando encontrar um bug no seu código ou precisa desativar o funcionamento de parte dele, utilize as tags de comentário no começo e no fim desse código para bloqueá-lo. Dessa maneira, você poderá reativá-lo posteriormente apenas apagando as tags de comentário.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    Título da página </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     < 
     p 
     > 
    Observe estas imagens </ 
     p 
     > 
     < 
     img 
     src 
     = 
     "/images/imagem1.jpg" 
     > 
     <!-- As ''tags'' de comentário estão sendo 
     usadas para esconder essa parte do código 
     <img src="/images/imagem2.jpg"> 
     --> 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
  4. Se você programa em JavaScript ou VBScript , utilize as tags de comentário para esconder códigos de script que não sejam suportados em determinados navegadores. Insira a tag de abertura no início do código e termine usando a tag //--> para permitir que ele funcione somente em navegadores que tenham suporte para script [2] .
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    VBScript </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     < 
     script 
     language 
     = 
     "vbscript" 
     type 
     = 
     "text/vbscript" 
     > 
     <!-- 
     document 
     . 
     write 
     ( 
     "Olá mundo!" 
     ) 
     //--> 
     </ 
     script 
     > 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
    • Os caracteres // na tag de fechamento permitem que o navegador (caso ele reconheça a função script ) desconsidere o comentário e execute o código script contido dentro dele.
    Publicidade

Dicas

  • Use comentários com frequência para que você possa reconhecer e lembrar do funcionamento de cada parte do código posteriormente.
  • Utiliza muito PHP? Aprenda a comentar em PHP.
Publicidade

Sobre este guia wikiHow

Esta página foi acessada 187 984 vezes.

Este artigo foi útil?

Publicidade