ReviewUnusedParameter

Nivel de gravedad: advertencia

Descripción

Esta regla identifica los parámetros declarados en un ámbito de script, scriptblock o función que no se han usado en ese ámbito.

Parámetros de configuración

De forma predeterminada, esta regla no tiene en cuenta los ámbitos secundarios que no sean los bloqueos de script proporcionados a Where-Object o ForEach-Object. La CommandsToTraverse configuración es una matriz de cadenas que permite agregar comandos adicionales que aceptan bloques de script que esta regla debe examinar.

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

Cómo

Considere la posibilidad de quitar el parámetro sin usar.

Ejemplo

Incorrecto

function Test-Parameter
{
    Param (
        $Parameter1,

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

    Get-Something $Parameter1
}

Correcto

function Test-Parameter
{
    Param (
        $Parameter1,

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

    Get-Something $Parameter1 $Parameter2
}