AvoidNullOrEmptyHelpMessageAttribute

重症度レベル:警告

デフォルト状態:常に有効

Description

このルールは、null 値、空文字列、または値割り当てがない HelpMessage 属性を検出します。 HelpMessage属性は意味のある空でない文字列値を含む必要があります。 この値を完全に省略すると、構文解析時の構文エラーが生じます。

空の文字列やnull値を使うと、PowerShellは実行時にエラーを発生させます。 パラメータの目的とユーザーに期待される入力を説明した説明的なヘルプメッセージを必ず提供してください。

例

非準拠

Function BadFuncEmptyHelpMessageEmpty
{
    Param(
        [Parameter(HelpMessage='')]
        [String]
        $Param
    )

    $Param
}

Function BadFuncEmptyHelpMessageNull
{
    Param(
        [Parameter(HelpMessage=$null)]
        [String]
        $Param
    )

    $Param
}

Function BadFuncEmptyHelpMessageNoAssignment
{
    Param(
        [Parameter(HelpMessage)]
        [String]
        $Param
    )

    $Param
}

対応

Function GoodFuncHelpMessage
{
    Param(
        [Parameter(HelpMessage='This is helpful')]
        [String]
        $Param
    )

    $Param
}

ルールの設定

このルールは常に有効で、設定はできません。 このルールを避けるために、以下のいずれかの方法を用いてください。

  • 欲しいルールだけを含めるか、不要なルールを除外するカスタムルール設定ファイルを作成しましょう。
  • 特定のコードブロックに対してルール抑制を抑制するために、適切なルール抑制属性をコードに追加してください。 詳細については、PSScriptAnalyzerの使用に関する「抑制ルール」セクションをご覧ください。
  • 最終更新: