Introduction au Projet de Documentation de FreeBSD pour les nouveaux participants
Précédent | Chapitre 3. Introduction à SGML | Suivant

# 3.5. Commentaires

*** A Traduire ***

Les commentaires suivent une syntaxe SGML et ne sont normalement autorisés que dans une DTD. Cependant comme la Section 3.4 le montre, il est possible d'inclure du SGML dans vos documents.

Les délimiteurs pour les commentaires SGML sont constitués de la chaîne de caractères ```--`''. Une première occurence ouvre le commentaire, et la seconde le ferme.

Exemple 3-8. Commentaire SGML générique

    <!-- C'est le texte du commentaire -->

    <!-- C'est un autre commentaire -->

    <!-- Voici une fa&ccedil;on de mettre un commentaire
         sur plusieurs lignes -->

    <!-- Voici une autre fa&ccedil;on --
      -- de le faire -->

Si vous avez déjà utilisé HTML auparavant, on vous a peut-être donné des règles différentes pour les commentaires. En particulier, vous pensez peut-être qu'ils commencent par `<!--` et ne se terminent qu'avec `-->`.

Ce n'est pas le cas. Les analyseurs syntaxiques de nombreux navigateurs sont défectueux et acceptent cette syntaxe. Ceux qu'utilisent le Projet de Documentation sont plus rigoureux et rejetteront les documents qui comportent cette erreur.

Exemple 3-9. Commentaires SGML erronnés

    <!-- C'est en commentaire --

         CE N'EST PAS EN COMMENTAIRE!

      -- retour au commentaire -->

L'analyseur SGML traitera cela comme s'il trouvait :

    <!CE N'EST PAS EN COMMENTAIRE>

Ce qui n'est pas du SGML valide et donnera des messages d'erreur source de confusion.

    <!--------------- C'est un tr&egrave;s mauvaise id&eacute;e --------------->

Comme l'exemple le suggère, ne mettez pas de commentaires de ce type.

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

C'est une (légèrement) meilleure idée, mais c'est toute de même une source de confusion potentielle pour les débutants en SGML.

## 3.5.1. A faire...

1. Ajoutez des commentaires à `exemple.sgml` et validez vos modifications avec nsgmls(1)

2. Ajoutez des commentaires incorrects à `exemple.sgml`, pour voir quels messages d'erreur produit alors nsgmls(1).

Précédent | Sommaire | Suivant
Revenir au SGML | Niveau supérieur | Entités

Ce document, ainsi que d'autres peut être téléchargé sur ftp.FreeBSD.org/pub/FreeBSD/doc/.

Pour toutes questions à propos de FreeBSD, lisez la documentation avant de contacter <questions@FreeBSD.org>.
Pour les questions sur cette documentation, contactez <doc@FreeBSD.org>.