AvoidNullOrEmptyHelpMessageAttribute

Poziom ważności: ostrzeżenie

Opis

Wartość atrybutu HelpMessage nie powinna być ciągiem pustym ani wartością null, ponieważ powoduje to, że interpreter programu PowerShell zgłasza błąd podczas wykonywania funkcji lub polecenia cmdlet.

Jak

Określ wartość atrybutu HelpMessage .

Przykład

Nieodpowiednim

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
}

Odpowiedź prawidłowa

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

    $Param
}