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!

Aktualisiert: 02.05.2022 von Bernhard ­čöö


Top-Artikel in diesem Bereich


Windows PowerShell Skript erstellen und ausf├╝hren
Im einfachsten Fall ist ein PowerShell-Skript eine Textdatei mit einer Reihe von PowerShell-Befehlen. Als PowerShell Skript versteht man eine Datei mit der Endung .ps1. Die Skriptdatei kann eine Sammlung von Befehlen, Funktionen oder Cmdlets enthalten.

Windows PowerShell Befehle: commands im ├ťberblick
die verf├╝gbaren PowerShell Befehle k├Ânnen mit dem Befehl:

PowerShell Loops und Array
Ein Array speichert mehrere Werte, ├Ąhnlich einer 2 spaltigen Tabelle.

Fragen / Kommentare