Dokumentation und Tests

Bonus

Lernziele

Kommentarbasierte Hilfe und Dokumentation erzeugen lassen und prüfen
Mit KI Testfälle für eine Funktion vorbereiten

Dokumentation

Bitte die KI, für eine fertige Funktion Comment-Based Help (.SYNOPSIS, .PARAMETER, .EXAMPLE) zu schreiben. Prüfe danach:

Stimmen die Beispiele? Führe sie aus.
Sind alle Parameter genannt?
Funktioniert Get-Help Funktionsname -Examples?

Tests vorbereiten

Für Skripte, die du oft änderst, lohnen sich automatische Tests mit Pester, dem Standard-Testframework für PowerShell.

Describe 'Get-FreierSpeicher' {
    It 'liefert ein Objekt mit FreiGB' {
        $ergebnis = Get-FreierSpeicher -Laufwerk C
        $ergebnis.FreiGB | Should -BeGreaterThan 0
    }
    It 'meldet Fehler bei unbekanntem Laufwerk' {
        { Get-FreierSpeicher -Laufwerk Q -ErrorAction Stop } | Should -Throw
    }
}

KI ist gut darin, Testfälle vorzuschlagen („Welche Grenzfälle sollte ich testen?“). Die Tests musst du verstehen: Ein Test, der immer grün ist, ist wertlos.

Install-PSResource Pester -Scope CurrentUser -TrustRepository   # falls nicht vorhanden
Invoke-Pester -Path C:\Kurs\Skripte