Get-MarkdownSyntax

ÜBERSICHT

Erzeugt aus dem Parameterblock einer PowerShell-Funktion eine standardisierte Syntaxzeile für Markdown-Dokumentationen.

SYNTAX

Get-MarkdownSyntax [[-Content] <string>] [[-FunctionName] <string>] [<CommonParameters>]

BESCHREIBUNG

Diese Funktion extrahiert aus dem übergebenen Skriptinhalt den Parameterblock einer PowerShell-Funktion und erzeugt daraus eine Syntaxzeile im üblichen PowerShell-Format.

Dabei werden folgende Regeln berücksichtigt:

• Parameter, die mit dem Attribut "Mandatory" gekennzeichnet sind, werden in eckige Klammern mit dem Datentyp in spitzen Klammern gesetzt, z. B. `[-Parameter] `.
• Optionale Parameter (ohne Mandatory-Attribut) werden zusätzlich in eckige Klammern gesetzt, z. B. `[[-Parameter] ]`.
• Switch-Parameter werden ohne Datentyp ausgegeben.
• Falls `[CmdletBinding()]` vorhanden ist, werden am Ende automatisch `[]` hinzugefügt.

Diese standardisierte Syntaxzeile eignet sich besonders gut für automatische Generierung von Markdown-Dokumentationen, um konsistente Funktionsbeschreibungen zu erzeugen.

PARAMETER

-Content

Type: string

Den vollständige Parameterblock der PowerShell-Skriptdatei als String, aus dem die Syntax extrahiert werden soll. beginnend mit `param(' oder mit vorgesetzten Attributen wie `[CmdletBinding()]` etc.

-FunctionName

Type: string

Der Name der Funktion, für die die Syntaxzeile erzeugt werden soll.

AUSGABEN

String

Gibt die generierte Syntaxzeile als String zurück.

BEISPIELE

# Liest eine PS1-Datei und gibt die Syntaxzeile für die Funktion 'MyFunction' zurück.
$content = Get-Content "MyFunction.ps1" -Raw
Get-MarkdownSyntax -Content $content -FunctionName "MyFunction"