AvoidNullOrEmptyHelpMessageAttribute

Nível de gravidade: aviso

Description

Essa regra detecta atributos HelpMessage que contêm valores nulos, strings vazias ou sem atribuição de valor. O HelpMessage atributo deve conter um valor de string significativo, não vazio. Omitir o valor completamente causa um erro de sintaxe em tempo de análise.

Usar uma string vazia ou valor nulo faz com que o PowerShell gere um erro em tempo de execução. Sempre forneça uma mensagem de ajuda descritiva que explique o propósito do parâmetro e a entrada esperada para os usuários.

Example

Não Conforme

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
}

Em conformidade

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

    $Param
}