Sie sind auf Seite 1von 13

THEMA

about_Comment_Based_Help
KURZBESCHREIBUNG
Beschreibt, wie kommentarbasierte Hilfethemen fr Funktionen und
Skripts geschrieben werden.
DETAILBESCHREIBUNG
Mithilfe spezieller Schlsselwrter fr Hilfekommentare knnen
Sie kommentarbasierte Hilfethemen fr Funktionen und Skripts
schreiben.
Vom Cmdlet "Get-Help" wird die kommentarbasierte Hilfe in dem
Format angezeigt, in dem auch die aus XML-Dateien generierten
Cmdlet-Hilfethemen angezeigt werden. Die Hilfe zu Funktionen und
Skripts knnen Sie mit allen Parametern von "Get-Help" anzeigen,
z. B. mit "Detailed", "Full", "Example" und "Online".
Mithilfe von Schlsselwrtern fr Hilfekommentare knnen Sie auch
XML-Hilfedateien fr Skripts und Funktionen schreiben, und Sie
knnen Benutzer zu einer anderen Hilfedatei umleiten.
In diesem Thema wird erlutert, wie Hilfethemen fr Funktionen
und Skripts geschrieben werden. Informationen zum Anzeigen von
Hilfethemen fr Funktionen und Skripts finden Sie unter "Get-Help".
SYNTAX FR DIE KOMMENTARBASIERTE HILFE
Fr die kommentarbasierte Hilfe gilt die folgende Syntax:
# .<Hilfeschlsselwort>
# <Hilfeinhalt>

-oder -
<#
.<Hilfeschlsselwort>
<Hilfeinhalt>
#>
Die kommentarbasierte Hilfe wird als Folge von Kommentaren
verfasst. Sie knnen vor jeder Zeile mit Kommentaren ein
Kommentarsymbol (#) eingeben oder mithilfe der Symbole "<#" und
"#>" einen Kommentarblock erstellen. Alle Zeilen innerhalb des
Kommentarblocks werden als Kommentare interpretiert.
Alle Zeilen in einem kommentarbasierten Hilfethema mssen
zusammenhngend sein. Wenn ein kommentarbasiertes Hilfethema auf
einen Kommentar folgt, der kein Teil des Hilfethemas ist, muss
mindestens eine Leerzeile zwischen der letzten nicht zur Hilfe
gehrenden Kommentarzeile und dem Anfang der kommentarbasierten
Hilfe eingefgt werden.
Die einzelnen Abschnitte der kommentarbasierten Hilfe werden
durch Schlsselwrter definiert. Jedem Schlsselwort der
kommentarbasierten Hilfe ist ein Punkt (.) vorangestellt. Die
Schlsselwrter knnen in beliebiger Reihenfolge angegeben
werden. Bei den Namen der Schlsselwrter wird die Gro- und
Kleinschreibung nicht beachtet.
Das Description-Schlsselwort steht z. B. vor der Beschreibung
einer Funktion oder eines Skripts.
<#
.Description
Mit Get-Function werden der Name und die Syntax aller
Funktionen in der Sitzung angezeigt.
#>
Der Kommentarblock muss mindestens ein Schlsselwort enthalten.
Einige Schlsselwrter (z. B. EXAMPLE) knnen mehrfach im
gleichen Kommentarblock angegeben werden. Der Hilfeinhalt fr das
jeweilige Schlsselwort beginnt in der Zeile nach dem
Schlsselwort und kann mehrere Zeilen umfassen.
SYNTAX FR DIE KOMMENTARBASIERTE HILFE IN FUNKTIONEN
Die kommentarbasierte Hilfe fr eine Funktion kann an drei
Stellen angezeigt werden:
-- Am Anfang des Funktionstexts.
-- Am Ende des Funktionstexts.
-- Vor dem Function-Schlsselwort. Zwischen der letzten Zeile
der Funktionshilfe und dem Function-Schlsselwort darf
hchstens eine Leerzeile vorhanden sein.

Beispiel:
function MeineFunktion
{
<#
.<Hilfeschlsselwort>
<Hilfeinhalt>
#>
<Funktionsbefehle>
}
-oder -
function MeineFunktion
{
<Funktionsbefehle>
<#
.<Hilfeschlsselwort>
<Hilfeinhalt>
#>
}
-oder -
<#
.<Hilfeschlsselwort>
<Hilfeinhalt>
#>
function MeineFunktion { }
SYNTAX FR DIE KOMMENTARBASIERTE HILFE IN SKRIPTS
Die kommentarbasierte Hilfe fr ein Skript kann im Skript an
einer der folgenden beiden Stellen angezeigt werden.
-- Am Anfang der Skriptdatei. Der Skripthilfe drfen im Skript
nur Kommentare und Leerzeilen vorangestellt sein.
-- Wenn das erste Element im Skripttext (nach der Hilfe) eine
Funktionsdeklaration ist, mssen zwischen dem Ende der
Skripthilfe und der Funktionsdeklaration mindestens zwei
Leerzeilen eingefgt werden. Andernfalls wird die Hilfe als
Hilfe fr die Funktion und nicht als Hilfe fr das Skript
interpretiert.
-- Am Ende der Skriptdatei.
Beispiel:
<#
.<Hilfeschlsselwort>
<Hilfeinhalt>
#>
function MeineFunktion { }
-oder-
function MeineFunktion { }
<#
.<Hilfeschlsselwort>
<Hilfeinhalt>
#>
SCHLSSELWRTER FR DIE KOMMENTARBASIERTE HILFE
Im Folgenden sind gltige Schlsselwrter fr die kommentarbasierte
Hilfe in der Reihenfolge aufgefhrt, in der sie normalerweise
in einem Hilfethema angegeben werden. Darber hinaus wird ihr
Verwendungszweck angegeben.
Diese Schlsselwrter knnen in der kommentarbasierten Hilfe in
beliebiger Reihenfolge angegeben werden, und ihre Gro- und
Kleinschreibung wird nicht bercksichtigt.
.SYNOPSIS
Eine kurze Beschreibung der Funktion oder des Skripts. Dieses
Schlsselwort kann in jedem Thema nur einmal angegeben werden.
.DESCRIPTION
Eine ausfhrliche Beschreibung der Funktion oder des Skripts.
Dieses Schlsselwort kann in jedem Thema nur einmal angegeben
werden.
.PARAMETER <Parametername>
Die Beschreibung eines Parameters. Fr jeden Parameter in der
Funktions- oder Skriptsyntax kann ein Parameter-Schlsselwort
angegeben werden.
Die Parameter-Schlsselwrter knnen im Kommentarblock in
beliebiger Reihenfolge angezeigt werden, die Funktions- oder
Skriptsyntax bestimmt jedoch die Reihenfolge, in der die
Parameter (und ihre Beschreibungen) im Hilfethema angezeigt
werden. Wenn die Reihenfolge gendert werden soll, mssen Sie
die Syntax ndern.

Sie knnen auch eine Parameterbeschreibung angeben, indem Sie
direkt vor dem Parametervariablennamen einen Kommentar in der
Funktions- oder Skriptsyntax platzieren.
Wenn Sie sowohl einen Syntaxkommentar als auch ein
Parameter-Schlsselwort verwenden, wird die zum
Parameter-Schlsselwort gehrende Beschreibung verwendet,
whrend der Syntaxkommentar ignoriert wird.
.EXAMPLE
Ein Beispielbefehl, der die Funktion oder das Skript
verwendet, nach dem optional eine Beispielausgabe und eine
Beschreibung angegeben sein knnen. Wiederholen Sie dieses
Schlsselwort fr jedes Beispiel.
.INPUTS
Die Microsoft .NET Framework-Typen von Objekten, die ber die
Pipeline an die Funktion oder das Skript bergeben werden
knnen. Sie knnen auch eine Beschreibung der Eingabeobjekte
einschlieen.
.OUTPUTS
Der .NET Framework-Typ der Objekte, die vom Cmdlet zurck-
gegeben werden. Sie knnen auch eine Beschreibung der
zurckgegebenen Objekte einschlieen.
.NOTES
Weitere Informationen zur Funktion oder zum Skript.
.LINK
Der Name eines verwandten Themas. Wiederholen Sie dieses
Schlsselwort fr jedes verwandte Thema.
Dieser Inhalt wird im Abschnitt "Verwandte Links" des
Hilfethemas angezeigt.
Der Inhalt zum Link-Schlsselwort kann auch einen URI
(Uniform Resource Identifier) zu einer Onlineversion desselben
Hilfethemas enthalten. Die Onlineversion wird geffnet, wenn
Sie den Online-Parameter von "Get-Help" verwenden. Der URI
muss mit "http" oder "https" beginnen.
.COMPONENT
Die Technologie oder das Feature, die von der Funktion oder
vom Skript verwendet werden bzw. auf die sie sich beziehen.
Dieser Inhalt wird angezeigt, wenn der Befehl "Get-Help" den
Component-Parameter von "Get-Help" enthlt.
.ROLE
Die Benutzerrolle fr das Hilfethema. Dieser Inhalt wird
angezeigt, wenn der Befehl "Get-Help" den Role-Parameter von
"Get-Help" enthlt.
.FUNCTIONALITY
Die vorgesehene Verwendung der Funktion. Dieser Inhalt wird
angezeigt, wenn der Befehl "Get-Help" den Functionality-
Parameter von "Get-Help" enthlt.
.FORWARDHELPTARGETNAME <Befehlsname>
Fhrt eine Umleitung zum Hilfethema fr den angegebenen
Befehl aus. Sie knnen Benutzer zu einem beliebigen
Hilfethema umleiten, u. a. zu Hilfethemen fr eine Funktion,
ein Skript, ein Cmdlet oder einen Anbieter.
.FORWARDHELPCATEGORY <Kategorie>
Gibt die Hilfekategorie des Elements in "ForwardHelpTargetName" an.
Gltige Werte sind Alias, Cmdlet, HelpFile, Function,
Provider, General, FAQ, Glossary, ScriptCommand,
ExternalScript, Filter und All. Vermeiden Sie mithilfe dieses
Schlsselworts Konflikte, die auf Befehle mit demselben Namen
zurckzufhren sind.
.REMOTEHELPRUNSPACE <Variable PSSession>
Gibt eine Sitzung an, die das Hilfethema enthlt. Geben Sie
eine Variable ein, die eine PSSession enthlt. Mit diesem
Schlsselwort werden vom Cmdlet "Export-PSSession" die
Hilfethemen fr exportierte Befehle gesucht.
.EXTERNALHELP <XML-Hilfedateipfad>
Gibt den Pfad zu einer XML-Hilfedatei fr das Skript oder die
Funktion an.
Wenn der angegebene Pfad zur XML-Datei unter Windows Vista
und hheren Windows-Versionen Unterverzeichnisse enthlt, die
spezifisch fr die jeweilige Benutzeroberflchenkultur sind,
durchsucht "Get-Help" die Unterverzeichnisse rekursiv nach
einer XML-Datei mit dem Namen des Skripts bzw. der Funktion.
Dabei werden die fr Windows Vista festgelegten
Ersatzsprachenstandards eingehalten, ebenso wie bei allen
XML-Hilfethemen.
Weitere Informationen zum XML-Hilfedateiformat fr die
Cmdlet-Hilfe finden Sie unter "How to Create Cmdlet Help" in
der MSDN (Microsoft Developer Network) Library unter
"http://go.microsoft.com/fwlink/?LinkID=123415" (mglicher-
weise auf Englisch).
AUTOMATISCH GENERIERTER INHALT
Der Name, die Syntax, die Parameterliste, die Parameterattribut-
tabelle, allgemeine Parameter und Hinweise werden automatisch vom
Cmdlet "Get-Help" generiert.
Name:
Der Abschnitt "Name" eines Hilfethemas fr eine Funktion
wird aus dem Funktionsnamen in die Funktionssyntax
bernommen. Der Name eines Hilfethemas fr ein Skript
wird aus dem Skriptdateinamen bernommen. Wenn Sie den
Namen oder seine Groschreibung ndern mchten, mssen
Sie die Funktionssyntax oder den Skriptdateinamen ndern.

Syntax:
Der Abschnitt "Syntax" des Hilfethemas wird aus der
Funktion oder der Skriptsyntax generiert. Um der
Hilfethemasyntax Details hinzuzufgen (z. B. den
.NET Framework-Typ eines Parameters), fgen Sie der Syntax
die gewnschten Details hinzu. Wenn Sie keinen Parameter-
typ angeben, wird der Typ "Object" als Standardwert
eingefgt.
Parameterliste:
Die Parameterliste im Hilfethema wird aus der Funktion
bzw. der Skriptsyntax sowie aus den Beschreibungen
generiert, die Sie mit dem Parameters-Schlsselwort
hinzufgen. Die Funktionsparameter werden im Abschnitt
"Parameters" des Hilfethemas in derselben Reihenfolge wie
in der Funktions- oder Skriptsyntax angezeigt. Die
Schreibweise und die Groschreibung von Parameternamen
werden ebenfalls aus der Syntax bernommen. Der durch das
Parameter-Schlsselwort angegebene Parametername hat
keine Auswirkungen.
Allgemeine Parameter:
Der Syntax und der Parameterliste des Hilfethemas werden
die allgemeinen Parameter hinzugefgt, selbst wenn sie
keine Auswirkungen haben. Weitere Informationen zu den
allgemeinen Parametern finden Sie unter
"about_CommonParameters".
Parameterattributtabelle:
"Get-Help" generiert die Tabelle der Parameterattribute,
die angezeigt wird, wenn der Full-Parameter oder der
Parameter-Parameter von Get-Help verwendet wird. Der Wert
der Attribute "Erforderlich", "Position" und
"Standardwert" wird aus der Funktions- bzw. Skriptsyntax
bernommen.
Hinweise:
Der Abschnitt "Hinweise" des Hilfethemas wird automatisch
vom Funktions- oder Skriptnamen generiert. Sein Inhalt
kann nicht gendert oder bearbeitet werden.
BEISPIELE
Beispiel 1: Kommentarbasierte Hilfe fr eine Funktion
Die folgende Beispielfunktion enthlt eine kommentarbasierte
Hilfe:
function Add-Extension
{
param ([string]$Name,[string]$Extension = "txt")
$name = $name + "." + $extension
$name
<#
.BERSICHT
Fgt einem angegebenen Namen eine Dateinamenerweiterung hinzu.
.DESCRIPTION
Fgt einem angegebenen Namen eine Dateinamenerweiterung
hinzu. Akzeptiert beliebige Zeichenfolgen fr den
Dateinamen oder die Dateinamenerweiterung.
.PARAMETER Name
Gibt den Dateinamen an.
.PARAMETER Extension
Gibt die Dateinamenerweiterung an. Der Standardwert
ist "txt".
.INPUTS
Keine. Objekte knnen nicht ber die Pipeline an
Add-Extension bergeben werden.
.OUTPUTS
System.String. Add-Extension gibt eine Zeichenfolge mit
der Erweiterung oder dem Dateinamen zurck.
.EXAMPLE
C:\PS> extension -name "Datei"
Datei.txt
.EXAMPLE
C:\PS> extension -name "Datei" -extension "doc"
Datei.doc
.EXAMPLE
C:\PS> extension "Datei" "doc"
Datei.doc
.LINK
Onlineversion: http://www.fabrikam.com/extension.html
.LINK
Set-Item
#>
}
Die Ergebnisse lauten wie folgt:
C:\PS> get-help add-extension -full
NAME
Add-Extension

BERSICHT
Fgt einem angegebenen Namen eine Dateinamenerweiterung hinzu.

SYNTAX
Add-Extension [[-Name] <String>] [[-Extension] <String>] [<CommonPar
ameters>]
BESCHREIBUNG
Fgt einem angegebenen Namen eine Dateinamenerweiterung
hinzu. Akzeptiert beliebige Zeichenfolgen fr den
Dateinamen oder die Dateinamenerweiterung.

PARAMETER
-Name
Gibt den Dateinamen an.

Erforderlich? false
Position? 0
Standardwert
Pipelineeingaben akzeptieren? false
Platzhalterzeichen akzeptieren?

-Extension
Gibt die Erweiterung an. Der Standardwert ist "txt".

Erforderlich? false
Position? 1
Standardwert
Pipelineeingaben akzeptieren? false
Platzhalterzeichen akzeptieren?

<CommonParameters>
Dieses Cmdlet untersttzt die folgenden allgemeinen
Parameter: -Verbose, -Debug, ErrorAction,
-ErrorVariable, -WarningAction, -WarningVariable,
OutBuffer und -OutVariable. Weitere Informationen
erhalten Sie mit folgendem Befehl: "get-help
about_commonparameters".

EINGABEN
Keine. Objekte knnen nicht ber die Pipeline an
Add-Extension bergeben werden.

AUSGABEN
System.String. Add-Extension gibt eine Zeichenfolge mit
der Erweiterung oder dem Dateinamen zurck.

-------------------------- BEISPIEL 1 --------------------------
C:\PS> extension -name "Datei"
Datei.txt

-------------------------- BEISPIEL 2 --------------------------
C:\PS> extension -name "Datei" -extension "doc"
Datei.doc

-------------------------- BEISPIEL 3 --------------------------
C:\PS> extension "Datei" "doc"
Datei.doc

VERWANDTE LINKS
Onlineversion: http://www.fabrikam.com/extension.html Set-Item
Beispiel 2: Parameterbeschreibungen in Funktionssyntax
Dieses Beispiel entspricht dem vorherigen. Hier werden jedoch
die Parameterbeschreibungen in der Funktionssyntax eingefgt.
Dieses Format ist insbesondere bei kurzen Beschreibungen
ntzlich.
function Add-Extension
{
param
(
[string]
# Gibt den Dateinamen an.
$name,
[string]
# Gibt die Erweiterung an. Der Standardwert ist "txt".
$extension = "txt"
)
$name = $name + "." + $extension
$name

<#
.SYNOPSIS
Fgt einem angegebenen Namen eine Dateinamenerweiterung hinzu.
.DESCRIPTION
Fgt einem angegebenen Namen eine Dateinamenerweiterung
hinzu. Akzeptiert beliebige Zeichenfolgen fr den
Dateinamen oder die Dateinamenerweiterung.
.INPUTS
Keine. Objekte knnen nicht ber die Pipeline an
Add-Extension bergeben werden.
.OUTPUTS
System.String. Add-Extension gibt eine Zeichenfolge mit
der Erweiterung oder dem Dateinamen zurck.
.EXAMPLE
C:\PS> extension -name "Datei"
Datei.txt
.BEISPIEL
C:\PS> extension -name "Datei" -extension "doc"
Datei.doc
.EXAMPLE
C:\PS> extension "Datei" "doc"
Datei.doc

.LINK
Onlineversion: http://www.fabrikam.com/extension.html
.LINK
Set-Item
#>
}
Beispiel 3: Kommentarbasierte Hilfe fr ein Skript
Das folgende Beispielskript enthlt eine kommentarbasierte Hilfe.
Beachten Sie die Leerzeilen zwischen der schlieenden spitzen
Klammer mit Raute "#>" und der Param-Anweisung. In einem
Skript ohne Param-Anweisung mssen mindestens zwei Leerzeilen
zwischen dem letzten Kommentar im Hilfethema und der ersten
Funktionsdeklaration vorhanden sein. Ohne diese Leerzeile
ordnet Get-Help das Hilfethema der Funktion und nicht dem
Skript zu.
<#
.SYNOPSIS
Fhrt monatliche Datenupdates aus.
.DESCRIPTION
Das Skript "Update-Monat.ps1" aktualisiert die
Registrierung mit neuen Daten, die whrend des vergangenen
Monats generiert wurden. Auerdem wird ein Bericht generiert.

.PARAMETER InputPath
Gibt den Pfad der CSV-Eingabedatei an.
.PARAMETER OutputPath
Gibt den Namen und den Pfad fr die CSV-Ausgabedatei an.
Standardmig generiert "Update-Monat.ps1" einen Namen aus
Datum und Uhrzeit seiner Ausfhrung und speichert die
Ausgabe im lokalen Verzeichnis.
.INPUTS
Keine. Sie knnen keine Objekte ber die Pipeline an
"Update-Monat.ps1" bergeben.
.OUTPUTS
Keine. "Update-Monat.ps1" generiert keine Ausgabe.
.EXAMPLE
C:\PS> .\Update-Monat.ps1
.EXAMPLE
C:\PS> .\Update-Monat.ps1 -inputpath C:\Daten\Januar.csv
.EXAMPLE
C:\PS> .\Update-Monat.ps1 -inputpath C:\Daten\Januar.csv
-outputPath C:\Berichte\2009\Januar.csv
#>
param ([string]$InputPath, [string]$OutPutPath)
function Get-Data { }
...
Mit dem folgenden Befehl wird die Skripthilfe aufgerufen. Da
sich das Skript nicht in einem Verzeichnis befindet, das in
der Path-Umgebungsvariablen aufgefhrt ist, muss im Befehl
"Get-Help" zum Abrufen der Skripthilfe der Skriptpfad
angegeben sein.
PS C:\ps-test> get-help .\update-monat.ps1 -full
NAME
C:\ps-test\Update-Monat.ps1

BERSICHT
Fhrt monatliche Datenupdates aus.

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

BESCHREIBUNG
Das Skript "Update-Monat.ps1" aktualisiert die
Registrierung mit neuen Daten, die whrend des
vergangenen Monats generiert wurden. Auerdem wird
ein Bericht generiert.

PARAMETER
-InputPath
Gibt den Pfad der CSV-Eingabedatei an.

Erforderlich? true
Position? 0
Standardwert
Pipelineeingaben akzeptieren? false
Platzhalterzeichen akzeptieren?

-OutputPath
Gibt den Namen und den Pfad fr die CSV-Ausgabedatei
an. Standardmig generiert "Update-Monat.ps1"
einen Namen aus Datum und Uhrzeit seiner
Ausfhrung und speichert die Ausgabe im lokalen
Verzeichnis.

Erforderlich? false
Position? 1
Standardwert
Pipelineeingaben akzeptieren? false
Platzhalterzeichen akzeptieren?
<CommonParameters>
Dieses Cmdlet untersttzt die folgenden
allgemeinen Parameter: -Verbose, -Debug,
ErrorAction, -ErrorVariable, -WarningAction,
-WarningVariable, OutBuffer und -OutVariable.
Weitere Informationen erhalten Sie mit folgendem
Befehl: "get-help about_commonparameters".

EINGABEN
Keine. Sie knnen keine Objekte ber die Pipeline
an "Update-Monat.ps1" bergeben.

AUSGABEN
Keine. "Update-Monat.ps1" generiert keine Ausgabe.


-------------------------- BEISPIEL 1 --------------------------
C:\PS> .\Update-Monat.ps1

-------------------------- BEISPIEL 2 --------------------------
C:\PS> .\Update-Monat.ps1 -inputpath C:\Daten\Januar.csv

-------------------------- BEISPIEL 3 --------------------------
C:\PS> .\Update-Monat.ps1 -inputpath C:\Daten\Januar.csv -outputPath

C:\Berichte\2009\Januar.csv

VERWANDTE LINKS
Beispiel 4: Umleiten zu einer XML-Datei
Sie knnen XML-Hilfethemen fr Funktionen und Skripts
schreiben. Die kommentarbasierte Hilfe kann zwar leichter
implementiert werden, die XML-Hilfe ist jedoch erforderlich,
wenn Sie den Hilfeinhalt genauer festlegen mchten oder wenn
Hilfethemen in mehrere Sprachen bersetzt werden sollen.
Im folgenden Beispiel werden die ersten Zeilen des Skripts
"Update-Monat.ps1" veranschaulicht. Das Skript gibt mithilfe
des ExternalHelp-Schlsselworts den Pfad zu einem
XML-Hilfethema fr das Skript an.
# .ExternalHelp C:\MeineSkripts\Update-Monat-Hilfe.xml
param ([string]$InputPath, [string]$OutPutPath)
function Get-Data { }
...
Im folgenden Beispiel wird die Verwendung des ExternalHelp-
Schlsselworts in einer Funktion veranschaulicht.
function Add-Extension
{
param ([string] $name, [string]$extension = "txt")
$name = $name + "." + $extension $name

# .ExternalHelp C:\ps-test\Add-Extension.xml
}
Beispiel 5: Umleiten zu einem anderen Hilfethema
Der folgende Code ist ein Auszug aus dem Anfang der
integrierten Windows PowerShell-Hilfefunktion, von der
jeweils ein Bildschirm mit Hilfetext angezeigt wird. Da im
Hilfethema fr das Cmdlet "Get-Help" die Hilfefunktion
beschrieben wird, wird der Benutzer mit dem ForwardHelpTarget
Name-Schlsselwort und dem ForwardHelpCategory-Schlsselwort
zum Hilfethema fr das Cmdlet "Get-Help" umgeleitet.
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:
C:\PS> get-help help
NAME
Get-Help
BERSICHT
Zeigt Informationen zu Windows PowerShell-Cmdlets und -Konzepten
an.
...
SIEHE AUCH
about_Functions
about_Functions_Advanced_Parameters
about_Scripts
"How to Write Cmdlet Help"
(http://go.microsoft.com/fwlink/?LinkID=123415)