Get-CommentMapFromXsd

EulandaXtools — Funktionsreferenz

Get-CommentMapFromXsd

ÜBERSICHT

Extrahiert eine kommentierende Zuordnungstabelle aus einem XSD-Schema.

SYNTAX

Get-CommentMapFromXsd [[-XsdPath] <string>] [<CommonParameters>]

BESCHREIBUNG

Diese Funktion analysiert eine XSD-Datei zeilenweise und erstellt ein Mapping ('Hashtable') zwischen Pfadnamen von 'xs:element'-Einträgen und ihren zugehörigen XML-Kommentaren (''), sofern vorhanden. Dabei wird die Pfadtiefe berücksichtigt, sodass verschachtelte Elemente korrekt mit ihrem vollständigen Namen versehen werden, z.B.:

`EULANDA.RECHNUNG.POSITION.MENGE = "Menge der Position"`

Nur Inline-Kommentare (also solche, die in einer Zeile sowohl '' enthalten) werden ausgewertet. Die Funktion berücksichtigt einfache Strukturen bestehend aus 'xs:element', 'xs:sequence' und 'xs:complexType'. Sie ist besonders für den späteren Einsatz in PowerShell-Modulen gedacht, um Kommentare automatisch z.B. beim XML-Export als Dokumentation auszugeben.

PARAMETER

-XsdPath

Type: string

Pfad zur XSD-Datei, die analysiert werden soll.

AUSGABEN

hashtable

Ein Hashtable mit Schlüssel = Elementpfad (z.B. 'RECHNUNG.POSITION.MENGE') und Wert = Kommentartext.

BEISPIELE

# Erzeugt eine Mapping-Tabelle mit Kommentaren für spätere Verwendung beim XML-Export.
$map = Get-CommentMapFromXsd -XsdPath ".\schema\eulanda-invoice.xsd"

HINWEISE