Поделиться через


AvoidNullOrEmptyHelpMessageAttribute

Уровень серьезности: предупреждение

Описание

Значение атрибута HelpMessage не должно быть пустой строкой или значением NULL, так как это приводит к возникновению ошибки интерпретатора PowerShell при выполнении функции или командлета.

Как

Укажите значение атрибута HelpMessage .

Пример

Неправильно

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
}