Comentários: HTML, Javascript, CSS e PHP

Como criar comentários em HTML para emitir ou documentar códigos

Home Tecnologia

Comentários são usados para que determinada linha de código ou bloco de linhas sejam ignoradas. O objetivo de usar comentário pode ser simplesmente de documentar o código ou ignorar determinada linha para efeito de depuração de erro.

O uso de comentários pode ser feito em HTML, Javascript, CSS, PHP, ASP, ASP.NET e em outras linguagens.

Comentários em HTML

O comentário em HTML pode ser usado de duas formas: comentar uma única linha ou para um bloco de linhas, veja abaixo os dois exemplos em um documento HTML.

<html xmlns="https://www.w3.org/1999/xhtml">
<head>
    <title>Comentários em HTML</title>
</head>
<body>
    <!-- Isto é um comentário de uma única linha -->
    <h1>Título da página</h1>
    <!-- Início do comentário de blogo
    <ul>
        <li>Este é um comentário </li>
        <li>de bloco.</li>
        <li>Certo?</li>
    </ul>
    final do comentário de blogo -->
</body>
</html>

Comentários em Javascript e PHP

Javascript e PHP também permitem o uso de comentários e assim como o HTML, ele pode ser de uma única linha ou em Blocos. 

Comentários de uma única linha serão iniciados por // (duas barras), já os comentários em blocos serão iniciados por /* (barra e asterisco) e terminados com */ (asterísco e barra). Veja o exemplo abaixo:

// Este é um comentário de uma única linha
/* Este é um comentário em bloco
ou seja
em várias linhas */

Comentários em CSS

CSS permite o uso de comentários apenas em blocos, usando os mesmos caracteres do Javascript e PHP. Exemplo:

/* Este é um comentário em bloco em CSS
ou seja
em várias linhas */

Comentários em ASP e ASP.NET

ASP e ASP.NET também permite o uso de comentários, nestes casos o caracter usado para fazer comentários de uma única linha é o *** (aspas simples)*.

* No caso do ASP.NET é usado aspas simples se a linguagem escolhida for VB.NET

Conforme explicado no início do post, os comentários podem ser usados para documentar o início do código com informações do autor, data de criação do documento e finalidade. Creio que esta opção deve ser mais apreciada por programadores mais antigos que tem esta herança de outras linguagens de programação.

Uma boa prática para usar comentários em HTML é comentar o texto dentro do <SCRIPT> e <STYLE> para impedir que navegadores mais antigos, que não suportam scripting ou estilos possam mostrar  texto simples.

 

Gostou? Compartilhe



 

Leia também:



© 2008-2019 | Professor Digital | Política de Privacidade | Em Jesus Cristo eu confio