AvoidNullOrEmptyHelpMessageAttribute

Nível de gravidade: Aviso

Description

Esta regra deteta atributos HelpMessage que contêm valores nulos, strings vazias ou sem atribuição de valores. O HelpMessage atributo deve conter um valor de cadeia significativo, não vazio. Omitir o valor por completo causa um erro de sintaxe em tempo de análise partic.

Usar uma string vazia ou valor nulo faz com que o PowerShell gere um erro em tempo de execução. Forneça sempre uma mensagem de ajuda descritiva que explique o propósito do parâmetro e a entrada esperada aos utilizadores.

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
}

Compliant

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

    $Param
}