AvoidNullOrEmptyHelpMessageAttribute

嚴重性層級：警告

Description

此規則偵測包含空值、空字串或無值指派的 HelpMessage 屬性。 屬性 HelpMessage 必須包含有意義的非空字串值。 完全省略該值會導致解析時間的語法錯誤。

使用空字串或空值會導致 PowerShell 在執行時產生錯誤。 務必提供描述性的說明訊息，說明參數的目的及預期輸入給使用者。

Example

不合規

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
}

Compliant

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

    $Param
}