Docs

Developer

XML

Grundlagen

Comment

Kurzbeschreibung

Das XML-Element <Comment> dient der Dokumentation innerhalb einer Dokumentvorlage.

Kommentare erleichtern die Wartung und Weiterentwicklung einer Dokumentvorlage, indem sie fachliche oder technische Hinweise direkt im XML-Code festhalten.

Innerhalb von <Comment> darf ausschließlich einfacher Fließtext verwendet werden. XML-Code oder Zeichenfolgen mit XML-relevanten Zeichen wie < oder > sind nicht für die Verwendung innerhalb eines Kommentars geeignet.

Soll XML-Code vorübergehend deaktiviert oder als nicht auszuführendes Beispiel innerhalb der Dokumentvorlage erhalten bleiben, verwenden Sie stattdessen <Disabled>. Comment = Textnotiz / Disabled = XML stilllegen

Inhalte aus <Comment> werden bei der Dokumenterzeugung nicht berücksichtigt und erscheinen niemals im erzeugten Dokument.

Einordnung

Bereich: Grundlagen

Schwierigkeitsgrad: ⭐☆☆☆☆

Vorkenntnisse: Body

Siehe auch

Body

Block

Zweck

Mit <Comment> können Hinweise direkt innerhalb der XML-Dokumentvorlage hinterlegt werden.

Typische Inhalte sind beispielsweise:

Gründe für eine bestimmte Umsetzung,
Hinweise für spätere Erweiterungen,
Informationen zu Änderungen,
fachliche Besonderheiten,
Hinweise für andere Redakteure.

Kommentare dienen ausschließlich der Dokumentation und beeinflussen die Dokumenterzeugung nicht.

Nicht geeignete Inhalte

<Comment> ist ausschließlich für einfachen Fließtext vorgesehen.

Verwenden Sie innerhalb eines Kommentars insbesondere keine XML-Strukturen oder XML-relevanten Zeichen wie:

Folgender Inhalt ist daher nicht geeignet:

<Comment>
    Hier später <Variable Path="source.Name"> verwenden.
</Comment>

Position innerhalb der Dokumentvorlage

<Comment> darf ausschließlich direkt innerhalb des <Body> verwendet werden.

Es befindet sich somit auf derselben Ebene wie die <Block>-Elemente.

<Body>

    <Comment>
        Briefkopf im Juli 2026 angepasst.
    </Comment>

    <Block>

        <Content>

            ...

        </Content>

    </Block>

</Body>

Eine Verwendung innerhalb eines <Block>, <Content> oder anderer XML-Elemente ist nicht zulässig.

Eigenschaften

Eigenschaft	Wert
Enthält Attribute	Nein
Enthält Text	Ja
Wird im Dokument ausgegeben	Nein
Verarbeitung durch die Render-Engine	Nein
Verwendung innerhalb des `<Body>`	Ja
Verwendung innerhalb eines `<Block>`	Nein

Typische Verwendung

Kommentare eignen sich insbesondere, um

Änderungen nachvollziehbar zu dokumentieren,
besondere fachliche Entscheidungen zu erläutern,
Hinweise für andere Redakteure festzuhalten,
größere Dokumentabschnitte zu beschreiben.

Ein guter Kommentar erklärt den Hintergrund einer Umsetzung und nicht den unmittelbar folgenden XML-Code.

Weniger ist mehr

Kommentare verbessern die Verständlichkeit einer Dokumentvorlage.

Eine übermäßige Verwendung kann jedoch die Lesbarkeit des XML-Codes beeinträchtigen.

Verwenden Sie Kommentare daher gezielt für Informationen, die sich nicht unmittelbar aus dem XML-Code ergeben.

Developer-Tipp

Ein Kommentar sollte möglichst beantworten:

„Warum wurde diese Lösung gewählt?“

Der XML-Code selbst beschreibt bereits, wie etwas umgesetzt wurde.

XML-Wissen

<Comment> gehört nicht zum eigentlichen Dokumentinhalt.

Die enthaltenen Informationen dienen ausschließlich der Dokumentation innerhalb der Dokumentvorlage.

Die Render-Engine ignoriert Kommentare vollständig.

Best Practices

Kommentare kurz und prägnant formulieren.
Nur Informationen dokumentieren, die für andere Redakteure einen Mehrwert bieten.
Veraltete Kommentare regelmäßig entfernen.
Änderungen und fachliche Entscheidungen dokumentieren.
Den XML-Code nicht unnötig mit Kommentaren überladen.

Hinweis

Eine gut strukturierte Dokumentvorlage benötigt häufig weniger Kommentare als eine unübersichtliche.

Kommentare sollten den XML-Code ergänzen – nicht ersetzen.

Zuletzt aktualisiert am 13. August 2026

Arbeiten im XML-Editor Disabled