Primer do Projeto de Documentação do FreeBSD para novos colaboradores
Anterior | Capítulo 3 SGML Primer | Próxima

# 3.5 Comentários

Comentários são uma construção SGML, e são normalmente válidos apenas dentro de um DTD. Entretanto, como mostrou a Seção 3.4, é possível utilizar sintaxe SGML com os seus documentos.

O delimitador para um comentário SGML é o conjunto de caracteres “`--`”. A primeira ocorrência deste conjunto de caracteres abre um comentário e a segunda fecha.

Exemplo 3-8. Comentário SGML genérico

    <!-- Teste de comentário -->

    <!-- Este é o interior do comentário -->

    <!-- Este é outro comentário    -->

    <!-- Esta é uma forma
         de fazer comentários de várias linhas -->

    <!-- Esta é outra forma  --
      -- de fazer comentários de várias linhas -->

Se você já utilizou HTML antes, você pode ter sido exposto a regras diferentes para comentários. Em particular, você pode pensar que o conjunto de caracteres `<!--` abre um comentário e que ele apenas é fechado por um `-->`.

Este não é o caso. Muitos dos navegadores web possuem interpretadores HTML quebrados, e irão aceitar isso como válido. Entretanto, os interpretadores SGML utilizados pelo projeto de documentação são muito mais rígidos, e irão rejeitar os documentos que contiverem este erro.

Exemplo 3-9. Comentários SGML errados

    <!-- Este é o comentário --

         Isto está fora do comentário!

      -- de volta para dentro do comentário -->

O interpretador SGML irá tratar isto como ele é realmente;

    <!Isto está fora do comentário>

Isto não é um SGML válido, e pode dar mensagens de erro confusas.

    <!--------------- Isto é uma idéia muito ruim --------------->

E como o exemplo sugere, não escreva comentários como esse.

    <!--===================================================-->

Esta é uma abordagem (ligeiramente) melhor, mas ele ainda é potencialmente confuso para as pessoas novas no uso do SGML.

## 3.5.1 Para você fazer…

1. Adicione alguns comentários ao arquivo `example.xml` e verifique se ele continua válido usando o `onsgmls`.

2. Adicione alguns comentários inválidos ao `example.xml` e veja as mensagens de erro que o `onsgmls` emite quando encontra um comentário inválido.

Anterior | Principal | Próxima
Voltando para o SGML | Acima | Entidades

Este, e outros documentos, podem ser obtidos em ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.

Para perguntas sobre FreeBSD, leia a documentação antes de contatar <questions@FreeBSD.org>.
Para perguntas sobre esta documentação, envie e-mail para <doc@FreeBSD.org>.