AvoidNullOrEmptyHelpMessageAttribute

Şiddet Seviyesi: Uyarı

Description

Bu kural, null değerler, boş dizilerle veya değer atamasız HelpMessage niteliklerini tespit eder. Öznitelik HelpMessage anlamlı, boş olmayan bir dizi değeri içermelidir. Değeri tamamen atlamak ayrıştırma zamanı sözdizimi hatasına yol açar.

Boş bir dizi veya null değer kullanmak, PowerShell'in çalışma zamanında hata oluşturmasına neden olur. Her zaman parametrelerin amacını ve beklenen girdileri açıklayan tanımlayıcı bir yardım mesajı gönderin.

Example

Standartlara Uygun Değil

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
}