AvoidNullOrEmptyHelpMessageAttribute

poziom ważności: ostrzeżenie

Description

Ta reguła wykrywa atrybuty HelpMessage zawierające wartości null, puste ciągi lub brak przypisania wartości. Atrybut HelpMessage musi zawierać znaczącą, niepustą wartość ciągu znaków. Całkowite pominięcie wartości powoduje błąd składni w czasie parsowania.

Użycie pustego ciągu lub wartości null powoduje wywołanie błędu przez PowerShell podczas działania. Zawsze dostarczaj opisową wiadomość pomocową, która wyjaśnia cel parametru i oczekiwane dane wejściowe dla użytkowników.

Example

Niezgodne

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
}

Zgodne

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

    $Param
}