UseCorrectCasing

Schweregrad: Informationen

BESCHREIBUNG

Diese Regel erkennt inkonsistente Casing in cmdlet-Namen, Parametern, Typnamen, Schlüsselwörtern und Operatoren. PowerShell ist, wo immer möglich, nicht groß- und kleinschreibungssensitiv, sodass das Gehäuse von CMDLET-Namen, Parametern, Schlüsselwörtern und Operatoren die Funktionalität nicht beeinflusst.

Diese Regel sorgt jedoch für eine einheitliche Verkleidung für Klarheit und Lesbarkeit. Die Verwendung von Kleinbuchstaben-Schlüsselwörtern hilft, sie von Befehlen zu unterscheiden, während die Verwendung von Kleinbuchstaben-Operatoren sie von Parametern unterscheidet.

Um diese Regel zu befolgen:

• Verwenden Sie die genaue Groß-/Kleinschreibung für Typnamen.
• Verwenden Sie exaktes Gehäuse für cmdlet- und Parameternamen.
• Verwenden Sie Kleinbuchstaben für Sprachstichwörter und Operatoren.

Example

Nicht konform

ForEach ($file in Get-childitem -Recurse) {
    $file.Extension -EQ '.txt'
}

invoke-command { 'foo' } -runasadministrator

Konform

foreach ($file in Get-ChildItem -Recurse) {
    $file.Extension -eq '.txt'
}

Invoke-Command { 'foo' } -RunAsAdministrator

Konfiguration

Rules = @{
    PSUseCorrectCasing = @{
        Enable        = $true
        CheckCommands = $true
        CheckKeyword  = $true
        CheckOperator = $true
    }
}

Die Parameter

Aktivieren

Dieser Parameter steuert, ob ScriptAnalyzer den Code anhand dieser Regel prüft. Es akzeptiert einen boolschen Wert. Um diese Regel zu aktivieren, setze diesen Parameter auf $true. Der Standardwert ist $false.

CheckCommands

Dieser Parameter steuert, ob ScriptAnalyzer prüft, ob das Gehäuse aller Befehls- und Parameternamen mit dem kanonischen Gehäuse übereinstimmt. Es akzeptiert einen boolschen Wert. Der Standardwert ist $true.

CheckKeyword

Dieser Parameter steuert, ob ScriptAnalyzer prüft, ob alle Sprach-Schlüsselwörter Kleinbuchstaben sind. Es akzeptiert einen boolschen Wert. Der Standardwert ist $true.

CheckOperator

Dieser Parameter steuert, ob ScriptAnalyzer prüft, ob alle Operatoren Kleinbuchstaben sind. Beispiel: -eq, -neund -gt. Es akzeptiert einen boolschen Wert. Der Standardwert ist $true.