about_Comment_Based_Help

Artikel
01/13/2025

Kurze Beschreibung

Beschreibt, wie Kommentarbasierte Hilfeinhalte für Funktionen und Skripts geschrieben werden.

Lange Beschreibung

Sie können kommentarbasierte Hilfeinhalte für Funktionen und Skripts schreiben, indem Sie spezielle Hilfekommentarstichwörter verwenden.

Das Cmdlet Get Help zeigt kommentargestützte Hilfe im gleichen Format an, in dem auch die aus XML-Dateien generierten Cmdlet-Hilfeinhalte angezeigt werden. Benutzer können alle Parameter von Get-Help, z. B. "Detailed", "Full", "Examples" und "Online", verwenden, um den Inhalt der kommentarbasierten Hilfe anzuzeigen.

Sie können auch XML-basierte Hilfedateien für Funktionen und Skripts schreiben. Verwenden Sie Get-Help das Schlüsselwort, um das .EXTERNALHELP Cmdlet zum Suchen der XML-basierten Hilfedatei für eine Funktion oder ein Skript zu aktivieren. Ohne dieses Schlüsselwort können Get-Help xml-basierte Hilfeinhalte für Funktionen oder Skripts nicht finden.

In diesem Thema wird erläutert, wie Sie Hilfeinhalte für Funktionen und Skripts schreiben. Informationen zum Anzeigen von Hilfeinhalten für Funktionen und Skripts finden Sie unter Get-Help.

Die Cmdlets "Update-Help" und "Save-Help" funktionieren nur für XML-Dateien. Die aktualisierbare Hilfe unterstützt keine kommentarbasierten Hilfeinhalte.

Syntax für kommentarbasierte Hilfe

Zum Erstellen von kommentarbasierten Hilfeinhalten können Sie entweder Einzeilenkommentare oder Blockkommentare verwenden.

Die Syntax für kommentarbasierte Hilfe lautet wie folgt:

# .<help keyword>
# <help content>

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

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

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.

Schlüsselwörter definieren jeden Abschnitt der kommentarbasierten Hilfe. Jedem kommentarbasierten Hilfeschlü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.

Das Schlüsselwort steht z. B .Description . vor einer Beschreibung einer Funktion oder eines Skripts.

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

Der Kommentarblock muss mindestens ein Schlüsselwort enthalten. Einige der Schlüsselwörter, z .EXAMPLE. B. , 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.

Syntax für kommentarbasierte Hilfe in Funktionen

Kommentarbasierte Hilfe für eine Funktion kann an einer von drei Speicherorten angezeigt werden:

Am Anfang des Funktionstexts.
Am Ende des Funktionstexts.
Vor dem function Schlüsselwort. Zwischen der letzten Zeile der Funktionshilfe und dem schlüsselwort function kann es nicht mehr als eine leere Zeile geben.

Zum Beispiel:

function Get-Function {
    <#
        .<help keyword>
        <help content>
    #>

    # function logic
}

function Get-Function {
    # function logic

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

<#
    .<help keyword>
    <help content>
#>
function Get-Function { }

Syntax für kommentarbasierte Hilfe in Skripts

Kommentarbasierte Hilfe für ein Skript kann an einem der folgenden beiden Speicherorte im Skript angezeigt werden.

Am Anfang der Skriptdatei. Die Skripthilfe kann im Skript nur durch Kommentare und leere Zeilen vorangestellt werden.

Wenn das erste Element im Skripttext (nach der Hilfe) eine Funktionsdeklaration ist, müssen mindestens zwei leere Zeilen zwischen dem Ende der Skripthilfe und der Funktionsdeklaration vorhanden sein. Andernfalls wird die Hilfe als Hilfe für die Funktion interpretiert, nicht als Hilfe für das Skript.
Am Ende der Skriptdatei Wenn das Skript jedoch signiert ist, platzieren Sie die kommentarbasierte Hilfe am Anfang der Skriptdatei. Das Ende des Skripts wird vom Signaturblock belegt.

Zum Beispiel:

<#
.<help keyword>
<help content>
#>
function Get-Function { }

function Get-Function { }
<#
.<help keyword>
<help content>
#>

Kommentarbasierte Hilfestichwörter

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

.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

Die Beschreibung eines Parameters. Fügen Sie ein .PARAMETER Schlüsselwort für jeden Parameter in der Funktions- oder Skriptsyntax hinzu.

Geben Sie den Parameternamen in derselben Zeile wie das Schlüsselwort ein .PARAMETER . Geben Sie die Parameterbeschreibung in die Zeilen ein, die auf das .PARAMETER Schlüsselwort folgen. Windows PowerShell interpretiert den gesamten Text zwischen der .PARAMETER Zeile und dem nächsten Schlüsselwort oder dem Ende des Kommentarblocks als Teil der Parameterbeschreibung. Die Beschreibung kann Absatzumbrüche enthalten.

.PARAMETER  <Parameter-Name>

Die Parameterstichwörter können in beliebiger Reihenfolge im Kommentarblock angezeigt werden, aber die Funktions- oder Skriptsyntax bestimmt die Reihenfolge, in der die Parameter (und ihre Beschreibungen) im Hilfethema angezeigt werden. Um die Reihenfolge zu ändern, ändern Sie die Syntax.

Sie können auch eine Parameterbeschreibung angeben, indem Sie einen Kommentar in der Funktion oder Skriptsyntax unmittelbar vor dem Namen der Parametervariablen platzieren. Damit dies funktioniert, müssen Sie auch über einen Kommentarblock mit mindestens einem Schlüsselwort verfügen.

Wenn Sie sowohl einen Syntaxkommentar als auch ein .PARAMETER Schlüsselwort verwenden, wird die dem Schlüsselwort zugeordnete .PARAMETER Beschreibung verwendet, und der Syntaxkommentar wird ignoriert.

<#
.SYNOPSIS
    Short description here
#>
function Verb-Noun {
    [CmdletBinding()]
    param (
        # This is the same as .Parameter
        [string]$Computername
    )
    # Verb the Noun on the computer
}

.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.

.OUTPUTS

Der .NET-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. Der Wert wird in der Zeile unterhalb des Schlüsselworts ".LINK" angezeigt und muss einem Kommentarsymbol # vorangestellt oder im Kommentarblock enthalten sein.

Wiederholen Sie das .LINK 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-Help. 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 denen die Funktion identifiziert ist. Der Component-Parameter verwendet Get-Help diesen Wert, um die suchergebnisse zu filtern, die von Get-Help.

.ROLE

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

.FUNCTIONALITY

Die Schlüsselwörter, die die beabsichtigte Verwendung der Funktion beschreiben. Der Get-Help" verwendet diesen Wert, um die suchergebnisse zu filtern, die von Get-Help.

.FORWARDHELPTARGETNAME

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. Gültige Werte sind Alias: , Cmdlet, HelpFile, Function, Provider, General, FAQGlossaryScriptCommandExternalScriptFilteroder .All Verwenden Sie dieses Schlüsselwort, um Konflikte zu vermeiden, wenn Befehle mit demselben Namen vorhanden sind.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE

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 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 .EXTERNALHELP Schlüsselwort 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 .EXTERNALHELP Schlüsselwort 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 .EXTERNALHELP Schlüsselworts 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, aber es wird empfohlen, das folgende Format zu verwenden:

<ScriptModule.psm1>-help.xml

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, Get-Help durchsucht die Unterverzeichnisse rekursiv nach einer XML-Datei mit dem Namen des Skripts oder der Funktion in Übereinstimmung mit den für Windows festgelegten Sprachfallbackstandards, genau wie in einem Modulverzeichnis.

Weitere Informationen zum XML-basierten Hilfedateiformat des Cmdlets finden Sie in der Hilfe zum Schreiben von Cmdlets.

Automatisch generierter Inhalt

Der Name, die Syntax, die Parameterliste, die Parameterattributetabelle, allgemeine Parameter und Hinweise werden automatisch vom Get-Help Cmdlet generiert.

Name

Der Name-Abschnitt eines Funktionshilfethemas stammt aus dem Funktionsnamen in der Funktionssyntax. Der Name eines Skripthilfethemas stammt aus dem Skriptdateinamen. Wenn Sie den Namen oder die Groß-/Kleinschreibung ändern möchten, ändern Sie die Funktionssyntax oder den Skriptdateinamen.

Syntax

Der Abschnitt "Syntax " des Hilfethemas wird aus der Funktions- oder Skriptsyntax generiert. Wenn Sie der Hilfethemasyntax Details hinzufügen möchten, z. B. den .NET-Typ eines Parameters, fügen Sie die Details zur Syntax hinzu. Wenn Sie keinen Parametertyp angeben, wird der Typ Object als Standardwert eingefügt.

Parameterliste

Die Parameterliste im Hilfethema wird aus der Funktions- oder Skriptsyntax und aus den Beschreibungen generiert, die Sie mithilfe des .Parameter Schlüsselworts hinzufügen. Die Funktionsparameter werden im Abschnitt "Parameter" des Hilfethemas in derselben Reihenfolge angezeigt, in der sie in der Funktions- oder Skriptsyntax angezeigt werden. Die Schreib- und Großschreibung von Parameternamen stammt auch aus der Syntax. Dies ist nicht von dem parameternamen betroffen, der durch das schlüsselwort .Parameter angegeben wurde.

Allgemeine Parameter

Die allgemeinen Parameter werden der Syntax- und Parameterliste des Hilfethemas hinzugefügt, auch wenn sie keine Auswirkung haben. Weitere Informationen zu den allgemeinen Parametern finden Sie unter about_CommonParameters.

Parameter-Attributtabelle

Get-Help generiert die Tabelle der Parameterattribute, die angezeigt werden, wenn Sie den Parameter "Full " oder "Parameter " verwenden Get-Help. Der Wert der Attribute "Erforderlich", "Position" und "Standardwert " wird aus der Funktions- oder Skriptsyntax übernommen.

Standardwerte und ein Wert für Wildcard-Zeichen akzeptieren werden nicht in der Attributtabelle angezeigt, auch wenn sie in der Funktion oder im Skript definiert sind. Um Benutzern zu helfen, stellen Sie diese Informationen in der Parameterbeschreibung bereit.

Hinweise

Der Abschnitt "Hinweise " des Hilfethemas wird automatisch aus dem Funktions- oder Skriptnamen generiert. Sie können den Inhalt nicht ändern oder beeinflussen.

Beispiele

Kommentarbasierte Hilfe für eine Funktion

Die folgende Beispielfunktion enthält kommentarbasierte Hilfe:

function Add-Extension
{
param ([string]$Name,[string]$Extension = "txt")
$name = $name + "." + $extension
$name

<#
.SYNOPSIS

Adds a file name extension to a supplied name.

.DESCRIPTION

Adds a file name extension to a supplied name.
Takes any strings for the file name or extension.

.PARAMETER Name
Specifies the file name.

.PARAMETER Extension
Specifies the extension. "Txt" is the default.

.INPUTS

None. You can't pipe objects to Add-Extension.

.OUTPUTS

System.String. Add-Extension returns a string with the extension
or file name.

.EXAMPLE

PS> extension -name "File"
File.txt

.EXAMPLE

PS> extension -name "File" -extension "doc"
File.doc

.EXAMPLE

PS> extension "File" "doc"
File.doc

.LINK

http://www.fabrikam.com/extension.html

.LINK

Set-Item
#>
}

Die Ergebnisse sind wie folgt:

Get-Help -Name "Add-Extension" -Full

NAME

Add-Extension

SYNOPSIS

Adds a file name extension to a supplied name.

SYNTAX

Add-Extension [[-Name] <String>] [[-Extension] <String>]
[<CommonParameters>]

DESCRIPTION

Adds a file name extension to a supplied name. Takes any strings for the
file name or extension.

PARAMETERS

-Name
Specifies the file name.

Required?                    false
Position?                    0
Default value
Accept pipeline input?       false
Accept wildcard characters?

-Extension
Specifies the extension. "Txt" is the default.

Required?                    false
Position?                    1
Default value
Accept pipeline input?       false
Accept wildcard characters?

<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug,
-ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
-OutBuffer and -OutVariable. For more information, type
"get-help about_commonparameters".

INPUTS
None. You can't pipe objects to Add-Extension.

OUTPUTS

System.String. Add-Extension returns a string with the extension or
file name.

Example 1

PS> extension -name "File"
File.txt

Example 2

PS> extension -name "File" -extension "doc"
File.doc

Example 3

PS> extension "File" "doc"
File.doc

RELATED LINKS

http://www.fabrikam.com/extension.html
Set-Item

Parameterbeschreibungen in Funktionssyntax

Dieses Beispiel entspricht dem vorherigen, mit der Ausnahme, dass die Parameterbeschreibungen in die Funktionssyntax eingefügt werden. Dieses Format ist am nützlichsten, wenn die Beschreibungen kurz sind.

function Add-Extension
{
param
(

[string]
#Specifies the file name.
$name,

[string]
#Specifies the file name extension. "Txt" is the default.
$extension = "txt"
)

$name = $name + "." + $extension
$name

<#
.SYNOPSIS

Adds a file name extension to a supplied name.

.DESCRIPTION

Adds a file name extension to a supplied name. Takes any strings for the
file name or extension.

.INPUTS

None. You can't pipe objects to Add-Extension.

.OUTPUTS

System.String. Add-Extension returns a string with the extension or
file name.

.EXAMPLE

PS> extension -name "File"
File.txt

.EXAMPLE

PS> extension -name "File" -extension "doc"
File.doc

.EXAMPLE

PS> extension "File" "doc"
File.doc

.LINK

http://www.fabrikam.com/extension.html

.LINK

Set-Item
#>
}

Kommentarbasierte Hilfe für ein Skript

Das folgende Beispielskript enthält kommentarbasierte Hilfe. Beachten Sie die leeren Zeilen zwischen dem Schließen #> und der Param Anweisung. In einem Skript, das nicht über eine Param-Anweisung verfügt, muss es mindestens zwei Leerzeilen zwischen dem endgültigen Kommentar im Hilfethema und der ersten Funktionsdeklaration geben. Ohne diese leeren Zeilen Get-Help ordnet das Hilfethema der Funktion und nicht dem Skript zu.

<#
.SYNOPSIS

Performs monthly data updates.

.DESCRIPTION

The Update-Month.ps1 script updates the registry with new data generated
during the past month and generates a report.

.PARAMETER InputPath
Specifies the path to the CSV-based input file.

.PARAMETER OutputPath
Specifies the name and path for the CSV-based output file. By default,
MonthlyUpdates.ps1 generates a name from the date and time it runs, and
saves the output in the local directory.

.INPUTS

None. You can't pipe objects to Update-Month.ps1.

.OUTPUTS

None. Update-Month.ps1 doesn't generate any output.

.EXAMPLE

PS> .\Update-Month.ps1

.EXAMPLE

PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv

.EXAMPLE

PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath `
C:\Reports\2009\January.csv
#>

param ([string]$InputPath, [string]$OutPutPath)

function Get-Data { }
...

Der folgende Befehl ruft die Skripthilfe ab. Da sich das Skript nicht in einem Verzeichnis befindet, das in der umgebungsvariablen $env:Path aufgeführt ist, muss der befehl Get-Help, der die Skripthilfe abruft, den Skriptpfad angeben.

Get-Help -Name .\update-month.ps1 -Full

# NAME

C:\ps-test\Update-Month.ps1

# SYNOPSIS

Performs monthly data updates.

# SYNTAX

C:\ps-test\Update-Month.ps1 [-InputPath] <String> [[-OutputPath]
<String>] [<CommonParameters>]

# DESCRIPTION

The Update-Month.ps1 script updates the registry with new data
generated during the past month and generates a report.

# PARAMETERS

-InputPath
Specifies the path to the CSV-based input file.

Required?                    true
Position?                    0
Default value
Accept pipeline input?       false
Accept wildcard characters?

-OutputPath
Specifies the name and path for the CSV-based output file. By
default, MonthlyUpdates.ps1 generates a name from the date
and time it runs, and saves the output in the local directory.

Required?                    false
Position?                    1
Default value
Accept pipeline input?       false
Accept wildcard characters?

<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug,
-ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
-OutBuffer and -OutVariable. For more information, type,
"get-help about_commonparameters".

# INPUTS

None. You can't pipe objects to Update-Month.ps1.

# OUTPUTS

None. Update-Month.ps1 doesn't generate any output.

Example 1

PS> .\Update-Month.ps1

Example 2

PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv

Example 3

PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath
C:\Reports\2009\January.csv

# RELATED LINKS

Umleiten zu einer XML-Datei

Sie können XML-basierte Hilfeinhalte für Funktionen und Skripts schreiben. Obwohl die kommentarbasierte Hilfe einfacher zu implementieren ist, ist xml-basierte Hilfe für aktualisierbare Hilfe erforderlich und um Hilfeinhalte in mehreren Sprachen bereitzustellen.

Das folgende Beispiel zeigt die ersten Zeilen des Skripts "Update-Month.ps1". Das Skript verwendet das .EXTERNALHELP Schlüsselwort, um den Pfad zu einem XML-basierten Hilfethema für das Skript anzugeben.

Beachten Sie, dass der Wert des .EXTERNALHELP Schlüsselworts in derselben Zeile wie das Schlüsselwort angezeigt wird. Jede andere Platzierung ist unwirksam.

# .EXTERNALHELP C:\MyScripts\Update-Month-Help.xml

param ([string]$InputPath, [string]$OutPutPath)
function Get-Data { }
...

Die folgenden Beispiele zeigen drei gültige Platzierungen des .EXTERNALHELP Schlüsselworts in einer Funktion.

function Add-Extension {
    # .EXTERNALHELP C:\ps-test\Add-Extension.xml

    param ([string] $name, [string]$extension = "txt")
    $name = $name + "." + $extension
    $name
}

function Add-Extension {
    param ([string] $name, [string]$extension = "txt")
    $name = $name + "." + $extension
    $name

    # .EXTERNALHELP C:\ps-test\Add-Extension.xml
}

# .EXTERNALHELP C:\ps-test\Add-Extension.xml
function Add-Extension {
    param ([string] $name, [string]$extension = "txt")
    $name = $name + "." + $extension
    $name
}

Umleiten zu einem anderen Hilfethema

Der folgende Code ist ein Auszug aus dem Anfang der integrierten Hilfefunktion in PowerShell, der jeweils einen Bildschirm mit Hilfetext anzeigt. Da das Hilfethema für das Get-Help Cmdlet die Hilfefunktion beschreibt, verwendet die Hilfefunktion die .ForwardHelpTargetName Und .ForwardHelpCategory Schlüsselwörter, um den Benutzer an das Get-Help Cmdlet-Hilfethema weiterzuleiten.

function help {
    <#
    .FORWARDHELPTARGETNAME Get-Help
    .FORWARDHELPCATEGORY Cmdlet
    #>

    [CmdletBinding(DefaultParameterSetName='AllUsersView')]
    param(
        [Parameter(Position=0, ValueFromPipelineByPropertyName=$true)]
        [System.String]
        ${Name},
    ...

Der folgende Befehl verwendet dieses Feature:

Get-Help -Name help

NAME

Get-Help

SYNOPSIS

Displays information about PowerShell cmdlets and concepts.
...

Freigeben über