Add-CommentsToXml

EulandaXtools — Funktionsreferenz

Add-CommentsToXml

ÜBERSICHT

Fügt kommentierende XML-Kommentare basierend auf einem Pfad-Mapping rekursiv in ein XML-Dokument ein.

SYNTAX

Add-CommentsToXml [[-XmlDoc] <System.Xml.XmlDocument>] [[-CommentMap] <hashtable>] [[-CurrentPath]
    <string>] [<CommonParameters>]

BESCHREIBUNG

Diese Funktion durchsucht ein XML-Dokument rekursiv und fügt an den entsprechenden Stellen Kommentare ein. Die Kommentare stammen aus der Hashtable `CommentMap`, deren Schlüssel verschachtelte Elementpfade wie `EULANDA.METADATA.DATE` darstellen und deren Werte die jeweiligen Kommentartexte sind.

Für jeden Pfad, der in der `CommentMap` gefunden wird, wird direkt vor dem zugehörigen XML-Knoten ein XML-Kommentar eingefügt.

PARAMETER

-XmlDoc

Type: System.Xml.XmlDocument

Ein XML-Dokument vom Typ `[System.Xml.XmlDocument]`, das kommentiert werden soll.

-CommentMap

Type: hashtable

Eine Hashtable, die Pfadnamen `EULANDA.X.Y` als Schlüssel und Kommentartexte als Werte enthält.

-CurrentPath

Type: string
Default: "EULANDA"

Gibt den Startpfad an, typischerweise `EULANDA`. Wird intern bei der Rekursion erweitert.

AUSGABEN

void

Kein Rückgabewert. Das übergebene XML-Dokument wird direkt verändert.

BEISPIELE

# Fügt für jeden in `$map` definierten Pfad den zugehörigen Kommentar ins Dokument `$doc` ein.
Add-CommentsToXml -XmlDoc $doc -CommentMap $map

HINWEISE

Die Pfade in der `CommentMap` müssen exakt mit der Verschachtelung im XML übereinstimmen und dies inkl. Groß-/Kleinschreibung der Tags in der `.ToUpper()`-Logik, wenn diese verwendet werden sollten.