Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts
Zurück | Kapitel 3. Die SGML-Fibel | Weiter

# 3.5. Kommentare

Kommentare sind SGML-Konstrukte, die normalerweise nur in DTDs gültig sind. Dennoch ist es, wie in Abschnitt 3.4 gezeigt, möglich Fragmente mit SGML-Syntax in Dokumenten zu verwenden.

Zum Abgrenzen von SGML-Kommentaren wird ein doppelter Bindestrich “`--`” verwendet. Mit seinem ersten Auftreten öffnet er einen Kommentar, mit seinem zweiten schließt er ihn wieder.

Beispiel 3-8. Beispiele für Kommentare in SGML

    <!-- Testkommentar -->

    <!-- Text innerhalb eines Kommentars -->

    <!-- Ein anderer Kommentar    -->

    <!-- So können mehrzeilige Kommentare
         genutzt werden -->

    <!-- Eine andere Möglichkeit für --
      -- mehrzeilige Kommentare.     -->

Hat man früher schon Erfahrungen mit HTML gesammelt, wird man vielleicht andere Regeln für den Gebrauch von Kommentaren kennengelernt haben. Beispielsweise wird oft angenommen, dass Kommentare mit `<!--` begonnen und nur mit `-->` beendet werden.

Dies ist nicht der Fall. Viele Webbrowser haben fehlerhafte HTML-Parser, die dies akzeptieren. Die SGML-Parser, die vom FDP verwendet werden, halten sich strenger an die SGML-Spezifikation und verwerfen Dokumente mit solchen Fehlern.

Beispiel 3-9. Fehlerhafte SGML-Kommentare

    <!-- Innerhalb eines Kommentars --

         DIES IST NICHT TEIL EINES KOMMENTARS

      -- Wieder innerhalb eines Kommentars -->

SGML-Parser würden die mittlere Zeile wie folgt interpretieren:

    <!DIES IST NICHT TEIL EINES KOMMENTARS>

Da es sich hierbei nicht um gültiges SGML handelt, kann diese Zeile zur verwirrenden Fehlermeldungen führen.

    <!--------------- Eine wirklich schlechte Idee  --------------->

Wie das Beispiel zeigt, sollten solche Kommentare tunlichst vermieden werden.

    <!--===================================================-->

Ein solcher Kommentar ist (ein wenig) besser, kann aber jemanden, der mit SGML noch nicht so vertraut ist, verwirren.

## 3.5.1. Fingerübungen…

1. Zur Übung können Sie einige Kommentare in die Datei `beispiel.xml` einfügen und überprüfen, ob die Datei nun noch erfolgreich von `onsgmls` validiert werden kann.

2. Zu Testzwecken sollten Sie auch noch ein paar fehlerhafte Kommentare hinzufügen und sich die resultierenden Fehlermeldungen von `onsgmls` ansehen.

Zurück | Zum Anfang | Weiter
Die Rückkehr zu SGML | Nach oben | Entitäten

Wenn Sie Fragen zu FreeBSD haben, schicken Sie eine E-Mail an <de-bsd-questions@de.FreeBSD.org>.
Wenn Sie Fragen zu dieser Dokumentation haben, schicken Sie eine E-Mail an <de-bsd-translators@de.FreeBSD.org>.