ReviewUnusedParameter

Poziom ważności: ostrzeżenie

Opis

Ta reguła identyfikuje parametry zadeklarowane w skrycie, bloku skryptu lub zakresie funkcji, które nie zostały użyte w tym zakresie.

Ustawienia konfiguracji

Domyślnie ta reguła nie uwzględnia zakresów podrzędnych innych niż skrypty udostępnione do Where-Object lub ForEach-Object. Ustawienie to tablica CommandsToTraverse ciągów umożliwia dodawanie dodatkowych poleceń, które akceptują blokady skryptów, które powinny zostać przeanalizowane przez tę regułę.

@{
    Rules = @{
        PSReviewUnusedParameter = @{
            CommandsToTraverse = @(
                'Invoke-PSFProtectedCommand'
            )
        }
    }
}

Jak

Rozważ usunięcie nieużywanego parametru.

Przykład

Nieodpowiednim

function Test-Parameter
{
    Param (
        $Parameter1,

        # this parameter is never called in the function
        $Parameter2
    )

    Get-Something $Parameter1
}

Odpowiedź prawidłowa

function Test-Parameter
{
    Param (
        $Parameter1,

        # now this parameter is being called in the same scope
        $Parameter2
    )

    Get-Something $Parameter1 $Parameter2
}