PowerShell: Cmdlet (erweiterte Funktion)

 

In PowerShell ISE kann mit Strg+J eine Vorlage für ein PowerShell Cmdlet eingefügt werden. Die Vorlage erweitert das Skript um Elemente für die Dokumentation und gibt damit der integrierten PowerShell-Hilfe alle notwendigen Informationen für das Cmdlet: "get-help".

Vorlagen in PowerShell ISE, siehe auch Powershell-Snippet.

Cmdlet Vorlage Header (erweiterte Funktion)

Die Vorlage kann als Basis für ein neues Cmdlet verwendet werden: Strg+J in PowerShell ISE und "Cmdlet (erweiterte Funktion)" bietet eine leere Vorlage für ein eigenes Cmdlet. 

Beim Einsatz der Vorlage "Cmdlet (erweiterte Funktion)", können bestimmte Eigenschaften im Header des Cmdlet für das Beschreiben der Funktion und Beispiele für den Aufruf, sowie die Parameter dokumentiert werden:

<#
.Synopsis
   Kurzbeschreibung
.DESCRIPTION
   Lange Beschreibung
.EXAMPLE
   Beispiel f├╝r die Verwendung dieses Cmdlets
.EXAMPLE
   Another example of how to use this cmdlet
#>
function Verb-Noun
{
    [CmdletBinding()]
    [Alias()]
    [OutputType([int])]
    Param
    (
        # Hilfebeschreibung zu Param1
        [Parameter(Mandatory=$true,
                   ValueFromPipelineByPropertyName=$true,
                   Position=0)]
        $Param1,

        # Hilfebeschreibung zu Param2
        [int]
        $Param2
    )

    Begin
    {
    }
    Process
    {
    }
    End
    {
    }
}

Get-Help

Wird für das Standard-Cmdlet die Hilfe aufgerufen: "get-help", liefert diese folgende Informationen:

PS C:\temp\> 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
        
    -Param2 <Int32>
        Hilfebeschreibung zu Param2
        
        Erforderlich?                false
        Position?                    named
        Standardwert                 0
        Pipelineeingaben akzeptieren?false
        Platzhalterzeichen akzeptieren?false
        
    <CommonParameters>
        Dieses Cmdlet unterst├╝tzt folgende allgemeine Parameter: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable und OutVariable. Weitere Informationen finden Sie unter 
        "about_CommonParameters" (https:/go.microsoft.com/fwlink/?LinkID=113216). 
    
EINGABEN
    
AUSGABEN
    System.Int32
    
    
    -------------------------- BEISPIEL 1 --------------------------
    
    PS C:\>Beispiel f├╝r die Verwendung dieses Cmdlets
    
    
    
    
    
    
    -------------------------- BEISPIEL 2 --------------------------
    
    PS C:\>Another example of how to use this cmdlet
    
    
    
    
    
    
    
VERWANDTE LINKS

Nachfolger PowerShell-ISE

Der Standard-PowerShell-Editor wird seitens Microsoft nicht mehr weiterentwickelt, als Nachfolger wird Visual Sudio Code gesehen, siehe: PowerShell Editoren im Vergleich: ISE, Visual Studio Code

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

DANKE f├╝r deine Bewertung!

Fragen / Kommentare


Durch die weitere Nutzung der Seite stimmst du der Verwendung von Cookies zu Mehr Details