De l'importance des commentaires bien formés en HTML

Des commentaires mal formés dans du code HTML standard peuvent saboter vos pages, certaines parties de votre code étant interprétées comme des commentaires. En XHTML ou XML, ces commentaires empêchent tout simplement l'affichage du document.

HTML 4.01

Extrait de W3C HTML 4.01 Recommendation Section 3.2.4 - Comments:

Les espaces ne sont pas autorisées entre le délimiteur d'ouverture de balise (« < ») et le délimiteur de début de commentaire (« -- »), mais sont permises entre le délimiteur de fin de commentaire (« -- ») et le délimiteur de fermeture de balise (« > »). Une erreur fréquente consiste à inclure une chaîne de tirets (« --- ») dans un commentaire. Les auteurs devraient éviter l'emploi de tirets adjacents à l'intérieur des commentaires.

Exemples

Les commentaires ci-dessous sont valides en HTML :

<!-- commentaire HTML valide -->
<!-- commentaire HTML valide -- >

Ce commentaire n'est pas valide en HTML :

<!-- commentaire HTML -- invalide -->

XML

Extrait de W3C XML 1.0 Recommendation Section 2.5 - Comments:

Définition : Les commentaires peuvent être placés n'importe où dans le document, mais à l'extérieur de tout autre balise ; ils peuvent également apparaître dans la déclaration de type de document aux endroits permis par la grammaire. Ils ne font pas partie des données caractères du document. Un processeur XML peut permettre à une application de récupérer le contenu des commentaires mais n'y est pas tenu. Pour des raisons de compatibilité, la séquence « -- » ne doit pas apparaître à l'intérieur d'un commentaire. Les références aux paramètres des entités ne doivent pas être interprétées à l'intérieur des commentaires.

[15] Commentaire ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

Comme il est expliqué dans la grammaire pour les commentaires en XML, un commentaire se présente sous la forme :

<!-- tout caractère sauf des tirets adjacents -->

Exemples

Le commentaire ci-dessous est valide en XML et en XHTML :

<!-- valid xml/xhtml comment -->

Les commentaires ci-dessous ne sont valides ni en XML, ni en XHTML :

<!-- invalid -- xml comment -->
<!-- invalid xml comment --->
<!-- invalid xml comment -- >

Références

• HTML 4.01 Recommendation: 3.2.4 - Comments
• XML Recommendation: 2.5 - Comments
• Bugzilla bug 144432
• Bugzilla bug 102127