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!


Top-Artikel in diesem Bereich

Preview PowerShell Loops und Array

PowerShell Loops und Array

geändert: 11.11.2020 von Bernhard (Erstveröffentlichung: 21.03.2013)

Ein Array speichert mehrere Werte, ähnlich einer 2 spaltigen Tabelle. ... weiterlesen

Preview wie erstelle ich ein Windows PowerShell Skript

wie erstelle ich ein Windows PowerShell Skript

geändert: 08.09.2021 von Bernhard (Erstveröffentlichung: 28.11.2012)

Ganz einfach erklärt: Ein PowerShell-Skript ist 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. ... weiterlesen

Preview Windows PowerShell Befehle im Überblick

Windows PowerShell Befehle im Überblick

geändert: 12.09.2017 von Bernhard (Erstveröffentlichung: 16.11.2011)

die verfügbaren PowerShell Befehle können mit dem Befehl: ... weiterlesen


Fragen / Kommentare


Wir verwenden Cookies, um Inhalte und Anzeigen zu personalisieren, Funktionen für soziale Medien anbieten zu können und die Zugriffe auf unsere Website zu analysieren. Außerdem geben wir Informationen zu Ihrer Nutzung unserer Website an unsere Partner für soziale Medien, Werbung und Analysen weiter. Details anzeigen.