تجنبNullOrEmptyHelpMessageAttribute

مستوى الخطورة : التحذير

Description

تكتشف هذه القاعدة سمات HelpMessage التي تحتوي على قيم فارغة، أو سلاسل فارغة، أو لا توجد تعيين قيمة. يجب أن تحتوي السمة HelpMessage على قيمة نصية ذات معنى وغير فارغة. حذف القيمة تماما يسبب خطأ في صياغة الوقت التحليلي.

استخدام سلسلة فارغة أو قيمة فارغة يؤدي إلى ظهور خطأ في PowerShell أثناء وقت التشغيل. دائما قدم رسالة مساعدة وصفية تشرح هدف المعامل ومدخلاته المتوقعة للمستخدمين.

مثال

غير متوافق

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
}

متوافقه

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

    $Param
}