ReviewUnusedParameter

Tingkat Keparahan: Peringatan

Deskripsi

Aturan ini mengidentifikasi parameter yang dideklarasikan dalam skrip, blok skrip, atau cakupan fungsi yang belum digunakan dalam cakupan tersebut.

Pengaturan konfigurasi

Secara default, aturan ini tidak mempertimbangkan cakupan anak selain blok skrip yang disediakan untuk Where-Object atau ForEach-Object. Pengaturan CommandsToTraverse adalah array string memungkinkan Anda menambahkan perintah tambahan yang menerima blok skrip yang harus diperiksa aturan ini.

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

Bagaimana

Pertimbangkan untuk menghapus parameter yang tidak digunakan.

Contoh

Salah

function Test-Parameter
{
    Param (
        $Parameter1,

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

    Get-Something $Parameter1
}

Benar

function Test-Parameter
{
    Param (
        $Parameter1,

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

    Get-Something $Parameter1 $Parameter2
}