UseConsistentParametersKind

重症度レベル:警告

デフォルト状態:無効化

説明

このルールは関数がパラメータ定義に一貫して同じパターンを使わないかを検出します。 すべての関数は同じパラメータ定義パターンを使用して、コードベース全体で一貫したコードスタイルを強制するべきです。 設定済みのパラメータ定義タイプと一致しない関数は書き直してください。 単純なシナリオでは、 Inline 関数と ParamBlock 関数の定義パターンは機能的に同値です。

例

非準拠

function f([Parameter()]$FirstParam) {
    return
}

対応

function g {
    param([Parameter()]$FirstParam)
    return
}

ルールの設定

Rules = @{
    PSUseConsistentParametersKind  = @{
        Enable = $true
        ParametersKind = 'ParamBlock'
    }
}

Parameters

Enable

このパラメータは、ScriptAnalyzerがこのルールに対してコードをチェックするかどうかを制御します。 ブール値も受け入れます。 このルールを有効にするには、このパラメータを $trueに設定します。 既定値は $false です。

パラメータ種類

このパラメータを使って、すべての関数で一貫して使用すべきパラメータ定義パターンの種類を指定します。 文字列の値を受け付けており、その値は Inline または ParamBlockのいずれかです。 既定値は ParamBlock です。