AvoidNullOrEmptyHelpMessageAttribute

úroveň závažnosti : Upozornění

Description

Toto pravidlo detekuje atributy HelpMessage , které obsahují nulové hodnoty, prázdné řetězce nebo žádné přiřazení hodnot. Atribut HelpMessage musí obsahovat smysluplnou, neprázdnou hodnotu řetězce. Úplné vynechání hodnoty způsobuje chybu syntaxe v čase parsování.

Použití prázdného řetězce nebo nulové hodnoty způsobí, že PowerShell během běhu vyvolá chybu. Vždy poskytněte popisnou nápovědu, která uživatelům vysvětlí účel parametru a očekávaný vstup.

Example

Nesplňující

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
}

Kompatibilní

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

    $Param
}