Udostępnij przez


UseSingularNouns

Poziom ważności: ostrzeżenie

Opis

Polecenia cmdlet stanu najlepszych rozwiązań zespołu programu PowerShell powinny używać pojedynczych un, a nie liczby mnogiej. Pomijanie umożliwia pomijanie reguły dla określonych nazw funkcji. Na przykład:

function Get-Elements {
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', 'Get-Elements')]
    Param()
}

Konfigurowanie

Rules = @{
    PSUseSingularNouns = @{
        Enable           = $true
        NounAllowList    = 'Data', 'Windows', 'Foos'
    }
}

Parametry

  • Enable: bool (Wartość domyślna to $true)

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

  • NounAllowList: string[] (Wartość domyślna to {'Data', 'Windows'})

    Polecenia, które mają zostać wykluczone z tej reguły. Data i Windows są często fałszywie dodatnie i są domyślnie wykluczone.

Jak

Zmień liczbę mnogą na pojedynczą.

Przykład

Nieodpowiednim

function Get-Files
{
    ...
}

Odpowiedź prawidłowa

function Get-File
{
    ...
}