Wenn Sie daran interessiert sind, Referenzkommentare zu Ihrem XML-Code, verwenden Sie diese Schritt-für-Schritt-Anleitung zur Anleitung. Sie können in nur fünf Minuten lernen, wie Sie diese Funktion ausführen. Obwohl der Vorgang einfach durchzuführen ist, sollten Sie dennoch einige Grundlagen zu XML-Kommentaren und deren Nützlichkeit kennen, bevor Sie beginnen.
Warum XML-Kommentare nützlich sind
Kommentare in XML sind fast identisch mit Kommentaren in HTML, da beide dieselbe Syntax haben. Kommentare verwenden ermöglicht es Ihnen, den Code zu verstehen, den Sie vor Jahren geschrieben haben. Es kann auch einem anderen Entwickler helfen, der den von Ihnen entwickelten Code überprüft, um zu verstehen, was Sie geschrieben haben. Kurz gesagt liefern diese Kommentare Kontext für den Code.
Mit Kommentaren können Sie ganz einfach eine Notiz hinterlassen oder einen Teil eines XML-Codes vorübergehend entfernen. Obwohl XML als "selbstbeschreibende Daten" konzipiert ist, müssen Sie gelegentlich einen XML-Kommentar hinterlassen.
Einstieg
Kommentar-Tags bestehen aus zwei Teilen: dem Teil, der den Kommentar beginnt, und dem Teil, der ihn beendet. Fügen Sie zunächst den ersten Teil des Kommentar-Tags hinzu:
Dann schreiben Sie einen beliebigen Kommentar. Stellen Sie nur sicher, dass Sie Kommentare nicht in anderen Kommentaren verschachteln (weitere Informationen finden Sie in den Tipps). Danach schließen Sie das Kommentar-Tag:
-->
Nützliche Tipps
Beachten Sie beim Hinzufügen von Referenzkommentaren zu Ihrem XML-Code, dass diese nicht ganz oben in Ihrem Dokument stehen dürfen. In XML kann nur die XML-Deklaration an erster Stelle stehen:
Wie oben erwähnt, dürfen Kommentare nicht ineinander verschachtelt werden. Sie müssen Ihren ersten Kommentar schließen, bevor Sie einen zweiten öffnen. Außerdem können innerhalb von Tags keine Kommentare vorkommen, z.B.
.
Verwenden Sie die beiden Bindestriche (--) niemals außer am Anfang und am Ende Ihrer Kommentare. Alles in Kommentaren ist praktisch unsichtbar für die XML-Parser, achten Sie also sehr darauf, dass das, was übrig bleibt, noch gültig und wohlgeformt ist.
Einpacken
Wenn Sie noch Fragen zum Hinzufügen von Referenzkommentaren zu XML-Code haben, sollten Sie ein Buch lesen, das Ihnen einen detaillierten Überblick über die Funktionsweise des Prozesses gibt. Bücher wie"C# 5.0 Programmer's Reference" von Rod Stephens kann sich als hilfreich erweisen.