Udostępnij przez


UseCorrectCasing

poziom ważności: informacje

Opis

Jest to reguła stylu/formatowania. PowerShell jest nierozróżniający wielkość liter, gdzie to możliwe, więc oznaczenia nazw cmdletów, parametrów, słów kluczowych i operatorów nie mają znaczenia. Ta reguła zapewnia jednak spójną wielkość liter w celu zapewnienia przejrzystości i czytelności. Używanie małych słów kluczowych pomaga odróżnić je od poleceń. Używanie małych operatorów ułatwia odróżnienie ich od parametrów.

Jak

  • Użyj dokładnej wielkości liter dla nazw typów.
  • Użyj dokładnej wielkości liter polecenia cmdlet i jego parametrów.
  • Użyj małych liter dla słów kluczowych i operatorów języka.

Konfiguracja

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

Parametry

Włącz: wartość logiczna (wartość domyślna to $false)

Włącz lub wyłącz regułę podczas wywołania ScriptAnalyzer.

CheckCommands: wartość logiczna (wartość domyślna to $true)

Jeśli to prawda, wymagaj, aby przypadek wszystkich nazw poleceń i parametrów odpowiadał ich kanonicznemu oprawie.

CheckKeyword: wartość logiczna (wartość domyślna to $true)

Jeśli wartość true, wymagaj, aby wielkość wszystkich słów kluczowych byłaby małą literą.

CheckOperator: wartość logiczna (wartość domyślna to $true)

Jeśli wartość true, wymagaj, aby wszystkie operatory mają małe litery. Na przykład: -eq, -ne, -gt

Przykłady

Niewłaściwy sposób

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

invoke-command { 'foo' } -runasadministrator

Poprawny sposób

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

Invoke-Command { 'foo' } -RunAsAdministrator