Si vous souhaitez ajouter des commentaires de référence à votre Code XML, utilisez ce didacticiel pas à pas pour vous guider. Vous pouvez apprendre à exécuter cette fonction en seulement cinq minutes. Bien que le processus soit facile à réaliser, 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. Utilisation des commentaires vous permet de comprendre le code que vous avez écrit des années auparavant. Cela peut également aider un autre développeur qui révise 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 autodescriptives », vous devrez parfois laisser un commentaire XML.
Commencer
Les balises de commentaire sont composées de deux parties: la partie commençant le commentaire et la partie le terminant. Pour commencer, ajoutez la première partie de la balise de commentaire:
Ensuite, écrivez le commentaire que vous souhaitez. Assurez-vous simplement de ne pas imbriquer des commentaires dans d'autres commentaires (voir les conseils pour plus de détails). Après cela, vous fermerez la balise de commentaire:
-->
Conseils utiles
Lorsque vous ajoutez des commentaires de référence à votre code XML, n'oubliez pas 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 second. De plus, les commentaires ne peuvent pas apparaître dans les balises, par ex.
.
N'utilisez jamais les deux tirets (--) ailleurs qu'au début et à la fin de vos commentaires. Tout ce qui se trouve dans les commentaires est effectivement invisible pour le analyseur XML, alors faites très attention à 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" par Rod Stephens peut s'avérer utile.