Zweck

Die Funktion Kommentar einfügen fügt die XML-Grundstruktur eines Kommentars in eine Dokumentvorlage ein.

Kommentare ermöglichen es, Hinweise, Erläuterungen oder Informationen direkt im XML-Code zu hinterlegen, ohne die Verarbeitung der Dokumentvorlage zu beeinflussen.

Verwendung

Nach Auswahl der Funktion wird die XML-Grundstruktur eines Kommentars an der aktuellen Cursorposition in die geöffnete Dokumentvorlage eingefügt.

Kommentare sind für die Dokumentation auf der obersten Ebene (Root-Ebene) einer Dokumentvorlage vorgesehen und können dort beispielsweise zur Beschreibung größerer XML-Bereiche oder zur Kennzeichnung von Bearbeitungsständen verwendet werden.

Anschließend kann der Redakteur den gewünschten Kommentartext innerhalb der Kommentarstruktur ergänzen.

Hinweis

Kommentare sollten ausschließlich auf der obersten Ebene (Root-Ebene) der Dokumentvorlage eingefügt werden.

Eine Verwendung innerhalb verschachtelter XML-Strukturen oder zwischen untergeordneten XML-Elementen wird nicht empfohlen.

Technischer Hinweis

Die Funktion fügt ausschließlich die XML-Grundstruktur eines Kommentars ein.

Der Kommentar wird als Bestandteil des XML-Codes gespeichert und hat keinen Einfluss auf die Verarbeitung oder Ausgabe der Dokumentvorlage.