Comment commenter une ligne en XML

XML fournit un langage de balisage pour stocker des données et les transporter d'un endroit à un autre. Comme HTML, il utilise du texte brut que vous pouvez modifier dans n'importe quelle application qui écrit des fichiers TXT. Contrairement au HTML, les balises XML fournissent des détails descriptifs sur le contenu plutôt que des instructions visuelles pour l'afficher. Lorsque vous définissez des balises XML pour caractériser un ensemble d'informations, vous pouvez utiliser des commentaires pour servir deux objectifs dans votre travail: l'expliquer et en omettre des parties du code que d'autres applications traiter. Si vous connaissez déjà la syntaxe des commentaires HTML, vous connaissez également l'équivalent XML.

Si vous souhaitez commenter une seule ligne dans le code XML, insérez votre curseur au début d'une ligne que vous souhaitez commenter. Type A

Si votre ligne se compose de la déclaration « Utilisez cette section pour créer une description des chats adoptables », elle ressemble à ceci avec les deux balises de commentaire en place :

Vous voudrez lire votre commentaire pour vérifier qu'il ne contient aucune instance de deux tirets consécutifs autres que dans ses balises de commentaire d'ouverture et de fermeture. Les tirets consécutifs déclenchent un faux signal de fin de commentaire qui perturbe votre syntaxe.

Plutôt que de simplement commenter une seule ligne, vous devrez peut-être commenter toute une section de votre code XML. Pour ce faire, insérez votre curseur sur une ligne vierge au-dessus de la section de code XML que vous souhaitez commenter puis tapez un symbole inférieur à suivi d'un point d'exclamation et de deux tirets.

Pour terminer le commentaire, déplacez votre curseur sur une ligne vide après la section de code XML que vous commentez. Taper deux tirets suivis d'un symbole supérieur à. Avec les commentaires en place, une section de code XML ressemble à ceci :

Encore une fois, vous voudrez lire votre section commentée pour vérifier qu'elle ne contient pas de commentaire dans les lignes que vous avez commentées. Les commentaires imbriqués constituent une erreur dans XML.

Lorsque vous faites des commentaires, n'oubliez pas quelques règles de syntaxe XML de base. XML n'autorise pas l'utilisation du caractère inférieur à dans son code, sauf dans le cadre d'une balise de commentaire d'ouverture. Pour inclure le caractère dans autre chose qu'une balise de commentaire, saisissez-le en tant que référence d'entité, une séquence codée qui se transforme en un caractère spécifique lorsqu'une application analyse votre XML.

Chaque référence d'entité commence par une esperluette et se termine par un point-virgule. Entre ces deux caractères, la référence d'entité pour le symbole inférieur à contient les lettres minuscules "lt", sans les guillemets et la ponctuation. Le symbole supérieur à ne constitue pas un caractère illégal dans XML, mais il est recommandé d'utiliser également sa référence d'entité, qui inclut les lettres « gt ».

Sachez également que si vous ne parvenez pas à ouvrir et fermer vos commentaires correctement, ou à les placer autour d'une section de code qui contient un ID, votre XML ne sera pas analysé correctement.