Kommentare

(Auszug aus "XML in a Nutshell" von Elliotte Rusty Harold & W. Scott Means)

XML-Dokumente können kommentiert werden, sodass Koautoren sich selbst und einander Hinweise hinterlassen können, die dokumentieren, weshalb sie etwas getan haben oder was noch zu tun bleibt. XML-Kommentare ähneln syntaktisch HTML-Kommentaren. Sie beginnen wie in HTML mit <!-- und enden mit dem ersten Auftreten von -->. Zum Beispiel:

<!-- Ich muss diese Links irgendwann noch einmal testen und aktualisieren. -->

Der doppelte Bindestrich -- sollte innerhalb eines Kommentars nicht auftreten, sondern ist der schließenden Kombination --> vorbehalten. Und ein dreifacher Bindestrich als Teil des Schlusszeichens ---> ist strikt verboten!

Kommentare dürfen überall in den Zeichendaten eines Dokuments auftreten. Sie können auch vor oder hinter dem Wurzelelement stehen. (Kommentare sind keine Elemente, deshalb wird die Baumstruktur oder die Es-gibt-nur-ein-Wurzelelement-Regel für XML nicht verletzt.) Allerdings dürfen Kommentare nicht innerhalb eines Tags oder innerhalb eines anderen Kommentars auftauchen.

Anwendungen, die XML-Dokumente lesen und weiterverarbeiten, müssen Informationen, die in Kommentaren stehen, nicht unbedingt durchlassen. Sie können sie auch entfernen. Schreiben Sie deshalb keine Dokumente oder Anwendungen, die davon abhängen, dass der Inhalt irgendwelcher Kommentare verfügbar ist. Kommentare dienen einzig und allein dazu, den reinen Quellcode für menschliche Leser verständlicher zu gestalten. Sie sind nicht für Computerprogramme gedacht. Zu diesem Zweck sollten Sie eine Verarbeitungsanweisung verwenden.

  

<< zurück vor >>

 

 

 

Tipp der data2type-Redaktion:
Zum Thema XML bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

  


Copyright © 2005 O'Reilly Verlag GmbH & Co. KG
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "XML in a Nutshell" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

O’Reilly Verlag GmbH & Co. KG, Balthasarstraße 81, 50670 Köln, kommentar(at)oreilly.de