about_Comment_Based_Help
Kurze Beschreibung
Beschreibt das Schreiben kommentarbasierter Hilfethemen für Funktionen und Skripts.
Lange Beschreibung
Sie können kommentarbasierte Hilfethemen für Funktionen und Skripts schreiben, indem Sie spezielle Hilfekommentarschlüsselwörter verwenden.
Das Cmdlet Get-Help zeigt kommentarbasierte Hilfe im gleichen Format an, in dem die Cmdlet-Hilfethemen angezeigt werden, die aus XML-Dateien generiert werden. Benutzer können alle Parameter von Get-Help
verwenden, z. B . Detail, Vollständig, Beispiele und Online, um den Inhalt der kommentarbasierten Hilfe anzuzeigen.
Sie können auch XML-basierte Hilfedateien für Funktionen und Skripts schreiben. Verwenden Sie die Schlüsselwort (keyword), damit das Get-Help
Cmdlet nach der XML-basierten .ExternalHelp
Hilfedatei für eine Funktion oder ein Skript suchen kann. Ohne diesen Schlüsselwort (keyword) können Get-Help
keine XML-basierten Hilfethemen für Funktionen oder Skripts gefunden werden.
In diesem Thema wird erläutert, wie Sie Hilfethemen für Funktionen und Skripts schreiben. Informationen zum Anzeigen von Hilfethemen 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 Hilfethemen.
Syntax für kommentarbasierte Hilfe
Die Syntax für kommentarbasierte Hilfe lautet wie folgt:
# .<help keyword>
# <help content>
oder
<#
.<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 <#
Symbole und #>
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 auf einen Kommentar folgt, der nicht Teil des Hilfethemas ist, muss zwischen der letzten Kommentarzeile ohne Hilfe und dem Anfang der kommentarbasierten Hilfe mindestens eine Leerzeile vorhanden sein.
Schlüsselwörter definieren jeden Abschnitt der kommentarbasierten Hilfe. Jeder kommentarbasierten Hilfe Schlüsselwort (keyword) wird ein Punkt vorangestellt.
. Die Schlüsselwörter können in beliebiger Reihenfolge angezeigt werden. Bei Schlüsselwort (keyword) Namen wird die Groß-/Kleinschreibung nicht beachtet.
Beispielsweise geht die .Description
Schlüsselwort (keyword) einer Beschreibung einer Funktion oder eines Skripts voran.
<#
.Description
Get-Function displays the name and syntax of all functions in the session.
#>
Der Kommentarblock muss mindestens einen Schlüsselwort (keyword) enthalten. Einige der Schlüsselwörter, z .EXAMPLE
. B. , können mehrmals im selben Kommentarblock angezeigt werden. Der Hilfeinhalt für jede Schlüsselwort (keyword) beginnt in der Zeile nach dem Schlüsselwort (keyword) und kann sich über mehrere Zeilen erstrecken.
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 Funktionskörpers.
- Vor dem
function
Schlüsselwort (keyword). Zwischen der letzten Zeile der Funktionshilfe undfunction
dem Schlüsselwort (keyword) darf sich nicht mehr als eine leere Zeile befinden.
Beispiel:
function Get-Function
{
<#
.<help keyword>
<help content>
#>
# function logic
}
oder
function Get-Function
{
# function logic
<#
.<help keyword>
<help content>
#>
}
oder
<#
.<help keyword>
<help content>
#>
function Get-Function { }
Syntax für kommentarbasierte Hilfe in Skripts
Kommentarbasierte Hilfe für ein Skript kann an einer der beiden folgenden Speicherorte im Skript angezeigt werden.
Am Anfang der Skriptdatei. Der Skripthilfe können im Skript nur Kommentare und Leerzeilen vorangestellt werden.
Wenn das erste Element im Skripttext (nach der Hilfe) eine Funktionsdeklaration ist, müssen zwischen dem Ende der Skripthilfe und der Funktionsdeklaration mindestens zwei Leerzeilen 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 kommentarbasierte Hilfe am Anfang der Skriptdatei. Das Ende des Skripts wird vom Signaturblock belegt.
Beispiel:
<#
.<help keyword>
<help content>
#>
function Get-Function { }
oder
function Get-Function { }
<#
.<help keyword>
<help content>
#>
Syntax für kommentarbasierte Hilfe in Skriptmodulen
In einem Skriptmodul .psm1
verwendet die kommentarbasierte Hilfe die Syntax für Funktionen, nicht die Syntax für Skripts. Sie können die Skriptsyntax nicht verwenden, um Hilfe für alle in einem Skriptmodul definierten Funktionen bereitzustellen.
Wenn Sie beispielsweise die .ExternalHelp
Schlüsselwort (keyword) verwenden, um die XML-basierten Hilfedateien für die Funktionen in einem Skriptmodul zu identifizieren, müssen Sie jeder Funktion einen .ExternalHelp
Kommentar hinzufügen.
# .ExternalHelp <XML-file-name>
function <function-name>
{
...
}
Kommentarbasierte Hilfeschlüsselwörter
Im Folgenden sind gültige kommentarbasierte Hilfeschlüsselwörter aufgeführt. Sie werden in der Reihenfolge aufgeführt, in der sie in der Regel zusammen mit ihrer beabsichtigten Verwendung in einem Hilfethema angezeigt werden. Diese Schlüsselwörter können in der kommentarbasierten Hilfe in beliebiger Reihenfolge angezeigt werden, wobei die Groß-/Kleinschreibung nicht beachtet wird.
.SYNOPSIS
Eine kurze Beschreibung der Funktion oder des Skripts. Diese Schlüsselwort (keyword) kann nur einmal in jedem Thema verwendet werden.
.DESCRIPTION
Eine detaillierte Beschreibung der Funktion oder des Skripts. Diese Schlüsselwort (keyword) kann nur einmal in jedem Thema verwendet werden.
.PARAMETER
Die Beschreibung eines Parameters. Fügen Sie einen Schlüsselwort (keyword) für jeden Parameter in der Funktions- oder Skriptsyntax hinzu .PARAMETER
.
Geben Sie den Parameternamen in derselben Zeile wie die .PARAMETER
Schlüsselwort (keyword) ein. Geben Sie die Parameterbeschreibung in den Zeilen ein, die dem .PARAMETER
Schlüsselwort (keyword) folgen. Windows PowerShell interpretiert den gesamten Text zwischen der .PARAMETER
Zeile und dem nächsten Schlüsselwort (keyword) oder dem Ende des Kommentarblocks als Teil der Parameterbeschreibung.
Die Beschreibung kann Absatzumbrüche enthalten.
.PARAMETER <Parameter-Name>
Die Parameterschlüsselwörter können im Kommentarblock in beliebiger Reihenfolge 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 direkt vor dem Namen der Parametervariablen platzieren. Damit dies funktioniert, müssen Sie auch über einen Kommentarblock mit mindestens einem Schlüsselwort (keyword) verfügen.
Wenn Sie sowohl einen Syntaxkommentar als auch einen .PARAMETER
Schlüsselwort (keyword) verwenden, wird die Beschreibung verwendet, die dem .PARAMETER
Schlüsselwort (keyword) zugeordnet ist, 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 einer Beispielausgabe und einer Beschreibung. Wiederholen Sie diese Schlüsselwort (keyword) für jedes Beispiel.
.INPUTS
Die .NET-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-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 unter dem Schlüsselwort (keyword) ".LINK" angezeigt und muss ein Kommentarsymbol #
vorangestellt oder im Kommentarblock enthalten sein.
Wiederholen Sie die .LINK
Schlüsselwort (keyword) für jedes verwandte Thema.
Dieser Inhalt wird im Abschnitt Verwandte Links des Hilfethemas angezeigt.
Der .Link
Schlüsselwort (keyword) Inhalt kann auch einen URI (Uniform Resource Identifier) für eine Onlineversion desselben Hilfethemas enthalten. Die Onlineversion wird geöffnet, wenn Sie den Online-Parameter von Get-Help
verwenden. 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 zu der sie in Beziehung steht. Der Component-Parameter von Get-Help
verwendet diesen Wert, um die von Get-Help
zurü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-Help
zurückgegebenen Suchergebnisse zu filtern.
.FUNCTIONALITY
Die Schlüsselwörter, die die beabsichtigte Verwendung der Funktion beschreiben. Der Funktionsparameter von Get-Help
verwendet diesen Wert, um die von Get-Help
zurückgegebenen Suchergebnisse zu filtern.
.FORWARDHELPTARGETNAME
Leitet zum Hilfethema für den angegebenen Befehl um. Sie können Benutzer zu einem beliebigen Hilfethema umleiten, einschließlich Hilfethemen 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
, oder All
Filter
. Verwenden Sie diese Schlüsselwort (keyword), 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 (keyword) wird vom Cmdlet Export-PSSession verwendet, um die Hilfethemen für die exportierten Befehle zu suchen.
# .REMOTEHELPRUNSPACE <PSSession-variable>
.EXTERNALHELP
Gibt eine XML-basierte Hilfedatei für das Skript oder die Funktion an.
# .EXTERNALHELP <XML Help File>
Die .ExternalHelp
Schlüsselwort (keyword) ist erforderlich, wenn eine Funktion oder ein Skript in XML-Dateien dokumentiert ist. Ohne diese Schlüsselwort (keyword) Get-Help
kann die XML-basierte Hilfedatei für die Funktion oder das Skript nicht gefunden werden.
Die .ExternalHelp
Schlüsselwort (keyword) hat Vorrang vor anderen kommentarbasierten Hilfeschlüsselwörtern. Wenn .ExternalHelp
vorhanden, Get-Help
wird keine kommentarbasierte Hilfe angezeigt, auch wenn kein Hilfethema gefunden werden kann, das dem Wert des .ExternalHelp
Schlüsselwort (keyword) entspricht.
Wenn die Funktion von einem Modul exportiert wird, legen Sie den Wert des .ExternalHelp
Schlüsselwort (keyword) auf einen Dateinamen ohne Pfad fest. Get-Help
sucht den 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 eine bewährte Methode besteht darin, 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 benutzeroberflächenkulturspezifische Unterverzeichnisse enthält, Get-Help
durchsucht 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 help finden Sie unter How to Write Cmdlet Help Help.
Automatisch generierter Inhalt
Der Name, die Syntax, die Parameterliste, die Get-Help
Parameterattributetabelle, allgemeine Parameter und Hinweise werden automatisch vom Cmdlet generiert.
Name
Der Abschnitt Name eines Funktionshilfethemas wird dem Funktionsnamen in der Funktionssyntax entnommen. Der Name eines Skripthilfethemas wird dem Dateinamen des Skripts entnommen. Um den Namen oder die Groß-/Kleinschreibung zu ändern, ändern Sie die Funktionssyntax oder den Dateinamen des Skripts.
Syntax
Der Abschnitt Syntax des Hilfethemas wird aus der Funktions- oder Skriptsyntax generiert. Um der Syntax des Hilfethemas Details hinzuzufügen, z. B. den .NET-Typ eines Parameters, fügen Sie die Details zur Syntax hinzu. Wenn Sie keinen Parametertyp angeben, wird der Objekttyp 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üsselwort (keyword) hinzufügen. Die Funktionsparameter werden im Abschnitt Parameter des Hilfethemas in der gleichen Reihenfolge angezeigt wie in der Funktions- oder Skriptsyntax. Die Rechtschreibung und Großschreibung von Parameternamen wird ebenfalls der Syntax entnommen. Der Parametername, der vom .Parameter
Schlüsselwort (keyword) angegeben wird, wirkt sich nicht darauf aus.
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.
Parameterattributetabelle
Get-Help
generiert die Tabelle der Parameterattribute, die angezeigt werden, wenn Sie den Parameter Full oder Parameter von Get-Help
verwenden. Der Wert der Attribute Erforderlich, Position und Standardwert wird der Funktions- oder Skriptsyntax entnommen.
Standardwerte und ein Wert für Platzhalterzeichen akzeptieren werden nicht in der Parameterattributetabelle angezeigt, auch wenn sie in der Funktion oder dem Skript definiert sind. Um Benutzern zu helfen, geben Sie diese Informationen in der Parameterbeschreibung an.
Hinweise
Der Abschnitt Hinweise des Hilfethemas wird automatisch aus dem Namen der Funktion oder des Skripts 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 cannot 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 lauten 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 cannot 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 der Funktionssyntax
Dieses Beispiel entspricht dem vorherigen, mit dem Unterschied, 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 cannot 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 Leerzeilen zwischen dem Schließen #>
und der Param
Anweisung. In einem Skript ohne Param
Anweisung müssen mindestens zwei Leerzeilen zwischen dem letzten Kommentar im Hilfethema und der ersten Funktionsdeklaration vorhanden sein. Ohne diese Leerzeilen 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 cannot pipe objects to Update-Month.ps1.
.OUTPUTS
None. Update-Month.ps1 does not 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, der Get-Help
die Skripthilfe abruft, den Skriptpfad angeben.
Get-Help -Path .\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 cannot pipe objects to Update-Month.ps1.
# OUTPUTS
None. Update-Month.ps1 does not 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
Umleitung zu einer XML-Datei
Sie können XML-basierte Hilfethemen für Funktionen und Skripts schreiben. Obwohl kommentarbasierte Hilfe einfacher zu implementieren ist, ist XML-basierte Hilfe für die aktualisierbare Hilfe und zum Bereitstellen von Hilfethemen in mehreren Sprachen erforderlich.
Das folgende Beispiel zeigt die ersten Zeilen des Update-Month.ps1 Skripts.
Das Skript verwendet die .ExternalHelp
Schlüsselwort (keyword), um den Pfad zu einem XML-basierten Hilfethema für das Skript anzugeben.
Beachten Sie, dass der Wert des .ExternalHelp
Schlüsselwort (keyword) in derselben Zeile wie der Schlüsselwort (keyword) 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 der .ExternalHelp
Schlüsselwort (keyword) 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
}
Umleitung zu einem anderen Hilfethema
Der folgende Code ist ein Auszug aus dem Anfang der integrierten Hilfefunktion in PowerShell, die jeweils einen Bildschirm mit Hilfetext anzeigt.
Da das Hilfethema für das Get-Help
Cmdlet die Hilfefunktion beschreibt, verwendet die Help-Funktion die .ForwardHelpTargetName
Schlüsselwörter und .ForwardHelpCategory
, um den Benutzer zum Cmdlet-Hilfethema umzuleiten Get-Help
.
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.
...