Syntax der kommentarbasierten Hilfe

In diesem Abschnitt wird die Syntax der kommentarbasierten Hilfe beschrieben.

Syntaxdiagramm

Die Syntax für kommentarbasierte Hilfe lautet wie folgt:

# .< help keyword>
# <help content>

-oder-

<#
.< help keyword>
< help content>
#>

Syntaxbeschreibung

Kommentarbasierte Hilfe wird als Eine Reihe von Kommentaren geschrieben. Sie können vor jeder Kommentarzeile ein Kommentarsymbol (#) eingeben, oder Sie können die Symbole <# und #> verwenden, um einen Kommentarblock zu erstellen. Alle Zeilen innerhalb des Kommentarblocks werden als Kommentare interpretiert.

Jeder Abschnitt der kommentarbasierten Hilfe wird durch ein Schlüsselwort definiert, und jedem Schlüsselwort wird ein Punkt (.) vorangestellt. Die Schlüsselwörter können in beliebiger Reihenfolge angezeigt werden. Bei den Schlüsselwortnamen wird die Groß-/Kleinschreibung nicht beachtet.

Ein Kommentarblock muss mindestens ein Hilfeschlüsselwort enthalten. Einige der Schlüsselwörter, z. B. .EXAMPLE, können oft im gleichen Kommentarblock angezeigt werden. Der Hilfeinhalt für jedes Schlüsselwort beginnt in der Zeile nach dem Schlüsselwort und kann mehrere Zeilen umfassen.

Alle Zeilen in einem kommentarbasierten Hilfethema müssen zusammenhängend sein. Wenn ein kommentarbasiertes Hilfethema einem Kommentar folgt, der nicht Teil des Hilfethemas ist, muss mindestens eine leere Zeile zwischen der letzten Nicht-Hilfe-Kommentarzeile und dem Anfang der kommentarbasierten Hilfe vorhanden sein.

Das folgende kommentarbasierte Hilfethema enthält z. B. das .DESCRIPTION Schlüsselwort und dessen Wert, bei dem es sich um eine Beschreibung einer Funktion oder eines Skripts handelt.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>