PowerShell Cmdlet Hilfe

Die Hilfe in einem selbst erstellten Cmdlet ist ein einfacher Kommentarblock am Beginn einer Funktion, bzw. am Anfang einer PowerShell Skript-Datei.

Die Windows PowerShell-Hilfe wird in folgendem Artikel behandelt:  PowerShell Help. und das Erstellen eines Skripts in diesem:  wie erstelle ich ein Windows PowerShell Skript 

Als Vorlage f√ľr eine eigene Hilfe kann das Cmdlet-Snippet im PowerShell ISE verwendet werden, dies kann mit mit Strg+J und "Cmdlet (erweiterte Funktion)" eingef√ľgt werden:

Weitere Informationen zum Thema Snippet, siehe:  Powershell ISE - Snippet 

Kommentarblock - get-help

Hilfe in Windows PowerShell kann vor Beginn einer Funktion innerhalb des Kommentarblocks: (<# ..#>) hinterlegt werden.

<#
.Synopsis
kurze Beschreibung
#>
function MyFunction ($param1, $param2)
{
    
}

Achtung: Die Hilfe-Information darf nicht mehr als eine Zeile Abstand zwischen dem Kommentarblock und der darauffolgenden Funktion haben.

.Synopsis ist eine kurze Beschreibung

get-help myFunction

PS P:\> get-help MyFunction

NAME
    MyFunction

SYNTAX
    MyFunction [[-param1] <Object>] [[-param2] <Object>]


ALIASE
    Keine


HINWEISE
    Keine

PowerShell versucht anhand der Informationen im Skript einen Hilfetext zu erstellen, so wird zum Beispiel der Bereich¬†Syntax automatisch durch die verf√ľgbaren¬†Parameter ausgegeben.¬†Andere Bereiche, wie als Beispiel die¬†Kurzbeschreibung .Synopsis¬†muss nat√ľrlich im Skript angegeben werden.¬†

weitere Kommentar-Schl√ľsselw√∂rter¬†

cmdlet-Snippet im PowerShell-ISE-Editor (Strg +J)  PowerShell Übergabe von Variablen (Param) 

<#
.Synopsis
Kurzbeschreibung
.DESCRIPTION
Lange Beschreibung
.EXAMPLE
Beispiel f√ľr die Verwendung dieses Cmdlets
.EXAMPLE
Ein weiteres Beispiel f√ľr die Verwendung dieses Cmdlets
#>

 

Schl√ľsselwort Beschreibung
.Synopsis Kurzbeschreibung
.Description Lange Beschreibung
.Parameter Parameter-Beschreibung, kann auch direkt vor dem jeweiligen Parameter geschrieben werden
.Example Beispiel: kann auch mehrfach verwendet werden

Hilfe zu den jeweiligen Parametern

function Verb-Noun
{
    [CmdletBinding()]
    [Alias()]
    [OutputType([int])]
    Param
    (
        # Hilfebeschreibung zu Param1
        [Parameter(Mandatory=$true,
                   ValueFromPipelineByPropertyName=$true,
                   Position=0)]
        $Param1,

        # Hilfebeschreibung zu Param2
        [int]
        $Param2
    )

...

Wird ein Kommentar oberhalb eines Parameters hinzugef√ľgt, wird dieser automatisch als Hilfe f√ľr diesen Parameter interpretiert.

Aufruf von get-help und Anzeige:

PS P:\> get-help Verb-Noun -full

NAME
 Verb-Noun
 
√úBERSICHT
 Kurzbeschreibung
 
SYNTAX
 Verb-Noun [-Param1] <Object> [-Param2 <Int32>] [<CommonParameters>]
 
 
BESCHREIBUNG
 Lange Beschreibung
 

PARAMETER
 -Param1 <Object>
 Hilfebeschreibung zu Param1
 
 Erforderlich? true
 Position? 1
 Standardwert 
 Pipelineeingaben akzeptieren?true (ByPropertyName)
 Platzhalterzeichen akzeptieren?false

Aufruf von get-help und Anzeige f√ľr einen bestimmten Parameter:

PS P:\> get-help Verb-Noun -parameter Param1

-Param1 <Object>
 Hilfebeschreibung zu Param1
 
 Erforderlich? true
 Position? 1
 Standardwert 
 Pipelineeingaben akzeptieren?true (ByPropertyName)
 Platzhalterzeichen akzeptieren?false

 

positive Bewertung({{pro_count}})
Beitrag bewerten:
{{percentage}} % positiv
negative Bewertung({{con_count}})

DANKE f√ľr deine Bewertung!

Fragen / Kommentare