Comment-Based Hilfestichwörter

In diesem Thema werden die Schlüsselwörter in der kommentarbasierten Hilfe aufgelistet und beschrieben.

Schlüsselwörter in Comment-Based Hilfe

Nachfolgend sind gültige kommentarbasierte Hilfestichwörter aufgeführt. Sie werden in der Reihenfolge aufgeführt, in der sie in der Regel in einem Hilfethema zusammen mit ihrer beabsichtigten Verwendung angezeigt werden. Diese Schlüsselwörter können in beliebiger Reihenfolge in der kommentarbasierten Hilfe angezeigt werden, und die Groß-/Kleinschreibung wird nicht beachtet.

Beachten Sie, dass das schlüsselwort .EXTERNALHELP Vorrang vor allen anderen kommentarbasierten Hilfestichwörtern hat. Wenn .EXTERNALHELP vorhanden ist, zeigt das Cmdlet Get-Help keine kommentarbasierte Hilfe an, auch wenn keine Hilfedatei gefunden werden kann, die dem Wert des Schlüsselworts entspricht.

.SYNOPSIS

Eine kurze Beschreibung der Funktion oder des Skripts. Dieses Schlüsselwort kann nur einmal in jedem Thema verwendet werden.

.DESCRIPTION

Eine detaillierte Beschreibung der Funktion oder des Skripts. Dieses Schlüsselwort kann nur einmal in jedem Thema verwendet werden.

.PARAMETER <Parameter-Name>

Die Beschreibung eines Parameters. Sie können ein .PARAMETER Schlüsselwort für jeden Parameter in die Funktion oder das Skript einschließen.

Die .PARAMETER Schlüsselwörter können in beliebiger Reihenfolge im Kommentarblock angezeigt werden, aber die Reihenfolge, in der die Parameter in der param Anweisung oder Funktionsdeklaration angezeigt werden, bestimmt die Reihenfolge, in der die Parameter im Hilfethema angezeigt werden. Wenn Sie die Reihenfolge der Parameter im Hilfethema ändern möchten, ändern Sie die Reihenfolge der Parameter in der param-Anweisung oder Funktionsdeklaration.

Sie können auch eine Parameterbeschreibung angeben, indem Sie einen Kommentar in der param-Anweisung unmittelbar vor dem Namen der Parametervariablen platzieren. Wenn Sie sowohl einen param-Anweisungskommentar als auch ein .PARAMETER Schlüsselwort verwenden, wird die dem schlüsselwort .PARAMETER zugeordnete Beschreibung verwendet, und der Kommentar der param Anweisung wird ignoriert.

.EXAMPLE

Ein Beispielbefehl, der die Funktion oder das Skript verwendet, optional gefolgt von der Beispielausgabe und einer Beschreibung. Wiederholen Sie dieses Schlüsselwort für jedes Beispiel.

.INPUTS

Die .NET-Objekttypen, die an die Funktion oder das Skript weitergeleitet werden können. Sie können auch eine Beschreibung der Eingabeobjekte einschließen. Wiederholen Sie dieses Schlüsselwort für jeden Eingabetyp.

.OUTPUTS

Der .NET-Typ der Vom Cmdlet zurückgegebenen Objekte. Sie können auch eine Beschreibung der zurückgegebenen Objekte einschließen. Wiederholen Sie dieses Schlüsselwort für jeden Ausgabetyp.

.NOTES

Zusätzliche Informationen zur Funktion oder zum Skript.

.LINK

Der Name eines verwandten Themas. Wiederholen Sie dieses Schlüsselwort für jedes verwandte Thema. Dieser Inhalt wird im Abschnitt "Verwandte Links" des Hilfethemas angezeigt.

Der .LINK Schlüsselwortinhalt kann auch einen URI (Uniform Resource Identifier) zu einer Onlineversion desselben Hilfethemas enthalten. Die Onlineversion wird geöffnet, wenn Sie den Parameter Online von Get-Helpverwenden. Der URI muss mit http oder httpsbeginnen.

.COMPONENT

Der Name der Technologie oder des Features, die von der Funktion oder dem Skript verwendet wird, oder mit der bzw. mit der bzw. dem die Funktion verknüpft ist. Der Component Parameter von Get-Help verwendet diesen Wert, um die von Get-Helpzurückgegebenen Suchergebnisse zu filtern.

.ROLE

Der Name der Benutzerrolle für das Hilfethema. Der Role Parameter von Get-Help verwendet diesen Wert, um die von Get-Helpzurückgegebenen Suchergebnisse zu filtern.

.FUNCTIONALITY

Die Schlüsselwörter, die die beabsichtigte Verwendung der Funktion beschreiben. Der Functionality Parameter von Get-Help verwendet diesen Wert, um die von Get-Helpzurückgegebenen Suchergebnisse zu filtern.

.FORWARDHELPTARGETNAME <Command-Name>

Leitet zum Hilfethema für den angegebenen Befehl um. Sie können Benutzer zu jedem Beliebigen Hilfethema umleiten, einschließlich Hilfeinhalten für eine Funktion, ein Skript, ein Cmdlet oder einen Anbieter.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

Gibt die Hilfekategorie des Elements in .FORWARDHELPTARGETNAME an. Gültige Werte sind Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filteroder All. Verwenden Sie dieses Schlüsselwort, um Konflikte zu vermeiden, wenn Befehle mit demselben Namen vorhanden sind.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

Gibt eine Sitzung an, die das Hilfethema enthält. Geben Sie eine Variable ein, die ein PSSession--Objekt enthält. Dieses Schlüsselwort wird vom Cmdlet [Export-PSSession][09] verwendet, um den Hilfeinhalt für die exportierten Befehle zu finden.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Gibt eine XML-basierte Hilfedatei für das Skript oder die Funktion an.

# .EXTERNALHELP <XML Help File>

Das schlüsselwort .EXTERNALHELP ist erforderlich, wenn eine Funktion oder ein Skript in XML-Dateien dokumentiert ist. Ohne dieses Schlüsselwort kann Get-Help die XML-basierte Hilfedatei für die Funktion oder das Skript nicht finden.

Das schlüsselwort .EXTERNALHELP hat Vorrang vor anderen kommentarbasierten Hilfestichwörtern. Wenn .EXTERNALHELP vorhanden ist, zeigt Get-Help keine kommentarbasierte Hilfe an, auch wenn es kein Hilfethema finden kann, das dem Wert des schlüsselworts .EXTERNALHELP entspricht.

Wenn die Funktion von einem Modul exportiert wird, legen Sie den Wert des schlüsselworts .EXTERNALHELP auf einen Dateinamen ohne Pfad fest. Get-Help Sucht nach dem angegebenen Dateinamen in einem sprachspezifischen Unterverzeichnis des Modulverzeichnisses. Es gibt keine Anforderungen für den Namen der XML-basierten Hilfedatei für eine Funktion. Ab PowerShell 5.0 können Funktionen, die von einem Modul exportiert werden, in einer Hilfedatei dokumentiert werden, die für das Modul benannt ist. Sie müssen kein Kommentarschlüsselwort verwenden .EXTERNALHELP . Wenn die Test-Function Funktion beispielsweise vom MyModule Modul exportiert wird, können Sie die Hilfedatei MyModule-help.xmlbenennen. Das Get-Help Cmdlet sucht nach Hilfe für die Test-Function Funktion in der MyModule-help.xml Datei im Modulverzeichnis.

Wenn die Funktion nicht in einem Modul enthalten ist, fügen Sie einen Pfad zur XML-basierten Hilfedatei ein. Wenn der Wert einen Pfad enthält und der Pfad UI-kulturspezifische Unterverzeichnisse enthält, durchsucht Get-Help die Unterverzeichnisse rekursiv nach einer XML-Datei mit dem Namen des Skripts oder der Funktion gemäß den für Windows festgelegten Sprachfallbackstandards, genau wie in einem Modulverzeichnis.

Weitere Informationen zum XML-basierten Hilfedateiformat des Cmdlets finden Sie unter Hilfe zum Schreiben von Cmdlet-Hilfe.