Add-XmlHeaderComment

EulandaXtools — Funktionsreferenz

Add-XmlHeaderComment

ÜBERSICHT

Fügt einem XML-Dokument einen Kommentar direkt im Kopfbereich hinzu.

SYNTAX

Add-XmlHeaderComment [[-XmlDoc] <System.Xml.XmlDocument>] [[-CommentText] <string>]
    [<CommonParameters>]

BESCHREIBUNG

Diese Funktion ergänzt ein bestehendes `XmlDocument`-Objekt um einen XML-Kommentar. Falls eine XML-Deklaration `` vorhanden ist, wird der Kommentar direkt danach eingefügt. Andernfalls wird er als erstes Element eingefügt. Der Kommentartext wird vor dem Einfügen automatisch getrimmt. Die Funktion verändert das übergebene `XmlDocument` und gibt es als Ergebnis zurück.

PARAMETER

-XmlDoc

Type: System.Xml.XmlDocument

Das XML-Dokument vom Typ `[System.Xml.XmlDocument]`, dem der Kommentar hinzugefügt werden soll.

-CommentText

Type: string

Der Text, der als Kommentar im Kopfbereich des Dokuments eingefügt werden soll.

AUSGABEN

System.Xml.XmlDocument

Das veränderte XML-Dokument mit eingefügtem Kommentar.

BEISPIELE

# Fügt dem XML einen Kommentar direkt hinter der Deklaration hinzu.
$xml = [xml]'<?xml version="1.0"?><root></root>'
$xml = Add-XmlHeaderComment -XmlDoc $xml -CommentText "Erzeugt durch Export-Skript am 2025-05-15"