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 Microsoft .NET Framework-Typen von Objekten, die an die Funktion oder das Skript weitergeleitet werden können. Sie können auch eine Beschreibung der Eingabeobjekte einschließen.

.OUTPUTS

Der .NET Framework-Typ der Vom Cmdlet zurückgegebenen Objekte. Sie können auch eine Beschreibung der zurückgegebenen Objekte einschließen.

.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 Online Parameter von Get-Helpverwenden. Der URI muss mit "http" oder "https" beginnen.

.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 Hilfethemen für eine Funktion, ein Skript, ein Cmdlet oder einen Anbieter.

.FORWARDHELPCATEGORY <Category>

Gibt die Hilfekategorie des Elements in .FORWARDHELPTARGETNAMEan. Verwenden Sie dieses Schlüsselwort, um Konflikte zu vermeiden, wenn Befehle mit demselben Namen vorhanden sind.

Gültige Werte sind:

• Alias
• Cmdlet
• HelpFile
• Function
• Provider
• General
• FAQ
• Glossary
• ScriptCommand
• ExternalScript
• Filter
• Alle

.REMOTEHELPRUNSPACE <PSSession-variable>

Gibt eine Sitzung an, die das Hilfethema enthält. Geben Sie eine Variable ein, die eine PSSession enthält. Dieses Schlüsselwort wird vom cmdlet Export-PSSession verwendet, um die Hilfethemen für die exportierten Befehle zu finden.

.EXTERNALHELP <XML Help File>

Gibt den Pfad und/oder den Namen einer XML-basierten Hilfedatei für das Skript oder die Funktion an.

Das schlüsselwort .EXTERNALHELP weist das cmdlet Get-Help an, Hilfe für das Skript oder die Funktion in einer XML-basierten Datei zu erhalten. Das schlüsselwort .EXTERNALHELP ist erforderlich, wenn eine XML-basierte Hilfedatei für ein Skript oder eine Funktion verwendet wird. Ohne dies finden Get-Help keine Hilfedatei für die Funktion oder das Skript.

Das schlüsselwort .EXTERNALHELP hat Vorrang vor allen anderen kommentarbasierten Hilfestichwörtern. 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.

Wenn die Funktion von einem Skriptmodul exportiert wird, sollte der Wert von .EXTERNALHELP ein Dateiname ohne Pfad sein. Get-Help sucht die Datei in einem gebietsschemaspezifischen Unterverzeichnis des Modulverzeichnisses. Es gibt keine Anforderungen für den Dateinamen, aber es empfiehlt sich, das folgende Dateiformat zu verwenden: <ScriptModule>.psm1-help.xml.

Wenn die Funktion keinem Modul zugeordnet ist, schließen Sie einen Pfad und Dateinamen in den Wert des schlüsselworts .EXTERNALHELP ein. Wenn der angegebene Pfad zur XML-Datei 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 für alle XML-basierten Hilfethemen.

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