PowerSHELL Best Practice

Posted on: 24. Juli 2018
Bei PowerSHELL ist es genau so wichtig wie bei anderen Sprachen eine klare Linie zu haben wie die Scripts aufgebaut sind.

Gerade in der Zusammenarbeit mit anderen Kollegen oder bei einem Jobwechsel sollte die Nachvollziehbarkeit immer gegeben sein. Deshalb hier ein paar Tipps dazu.
Hier der Code aus dem Youtube-Video. Die Vorgehensweise und Bemerkungen findest du direkt als Kommentare (#Grün) im Code. So wird er dir ebenfalls in der PowerSHELL ISE angezeigt werden.
——————————————–
<# .SYNOPSIS
     Kurzbeschrieb des Cmdlets oder Moduls
.DESCRIPTION
     Ausführliche Beschreibung des Scripts
.NOTES
     File Name : Dateiname.ps1
     Author : Thomsa Dobler – germanpowershell.com
.VERSION
     Version 0.1 – Erstellung des Scripts
.EXAMPLE
     Beispiel wie das Script aufgerufen wird > meinscript.ps1 -computername „localhost“
.INPUTTYPE
     Auflistung der Parameter und Typen die das Script braucht oder erlaubt
.RETURNVALUE
     Rückgabewert welche das Script ausgibt
.COMPONENT
     Betroffene Komponenten z.B. Hyper-V, Active Directory, usw.
#>
<# 
Längerer Kommentar 
innerhalb eines Scripts 
mit Zeilenschaltung usw. 
#>            
            
# Kurzkommentar innerhalb des Scripts            
            
# Ebenen immer mit Tab (pro Ebene) einrücken z.B.            
for ($i = 0; $i -lt 10; $i++)            

    {            
                
        # Zeilen direkt kommentieren            
        Write-Host $i            
            
    }
——————————————–
Solltest du irgendwelche Fragen haben, dann kannst du diese gerne entweder hier im Blog oder direkt unter dem YouTube Video stellen. Ich gebe alles, deine Fragen zeitnahe zu beantworten oder ein entsprechendes Video darüber zu machen.
Gerade die Grundlagen-Videos werde ich nicht mit viel Text ausschmücken. Bei mir ist jeweils jede Code-Zeile direkt im Code Kommentiert (#Grün). Du kannst den Code direkt mit in dein Script kopieren und hast so eine gute Orientierungshilfe, sobald du die Scripts auf deine Bedürfnisse anpasst.

Ich erstelle und veröffentliche sämtliche Videos kostenlos und blende auch keine Werbung ein, dies will ich auch so beibehalten. Da das vermittelte Wissen aber in teuren Kursen erlangt werden kann, ist eine kleine Spende hin und wieder sicher keine schlechte Gegenleistung.