Ajouter des commentaires de référence à votre code XML

Si vous souhaitez ajouter des commentaires de référence à votre code XML, utilisez ce didacticiel détaillé pour vous guider. Vous pouvez apprendre à exécuter cette fonction en cinq minutes seulement. Bien que le processus soit facile à mener à bien, vous devez tout de même connaître quelques notions de base sur les commentaires XML et leur utilité avant de commencer.

Pourquoi les commentaires XML sont utiles

Les commentaires en XML sont presque identiques aux commentaires en HTML, car ils ont tous deux la même syntaxe. L'utilisation de commentaires vous permet de comprendre le code que vous avez écrit des années auparavant. Cela peut également aider un autre développeur qui examine le code que vous avez développé à comprendre ce que vous avez écrit. En bref, ces commentaires fournissent un contexte pour le code.

Avec les commentaires, vous pouvez facilement laisser une note ou supprimer temporairement une partie d'un code XML. Même si XML est conçu pour être des "données auto-descriptives", vous pouvez parfois avoir besoin de laisser un commentaire XML.

Commencer

Les balises de commentaire sont composées de deux parties: la partie commençant le commentaire et la partie la terminant. Pour commencer, ajoutez la première partie de la balise comment

Conseils utiles

Lorsque vous ajoutez des commentaires de référence à votre code XML, rappelez-vous qu'ils ne peuvent pas figurer tout en haut de votre document. En XML, seule la déclaration XML peut venir en premier:

Comme mentionné ci-dessus, les commentaires ne peuvent pas être imbriqués les uns dans les autres. Vous devez fermer votre premier commentaire avant d’en ouvrir un deuxième. De plus, les commentaires ne peuvent pas apparaître dans les balises, par exemple.

.

N'utilisez jamais les deux tirets (-) ailleurs qu'au début et à la fin de vos commentaires. Tout ce qui est dans les commentaires est en réalité invisible pour l'analyseur XML. Veillez donc à ce que ce qui reste soit toujours valide et bien formé.

Emballer

Si vous avez encore des questions sur l'ajout de commentaires de référence au code XML, vous pouvez lire un livre pour vous donner une image détaillée du fonctionnement du processus. Des livres tels que "Référence du programmeur C # 5.0" de Rod Stephens peut s'avérer utile.