AvoidNullOrEmptyHelpMessageAttribute

súlyossági szint: Figyelmeztetési

Description

Ez a szabály olyan HelpMessage attribútumokat észlel, amelyek null értékeket, üres stringeket vagy érték nélküli kiosztást tartalmaznak. Az HelpMessage attribútumnak tartalmaznia kell egy értelmes, nem üres string értéket. Az érték teljes elhagyása parse-idejű szintaxishibát okoz.

Egy üres string vagy null érték használata futtatáskor hibát okoz a PowerShell-ben. Mindig adj egy leíró segítség üzenetet, amely elmagyarázza a paraméter célját és a felhasználóknak elvárt bemenetet.

Example

Nem megfelelő

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
}

Megfelelő

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

    $Param
}