AvoidNullOrEmptyHelpMessageAttribute

Nivel de gravedad: advertencia

Descripción

El valor del HelpMessage atributo no debe ser una cadena vacía o un valor NULL, ya que esto hace que el intérprete de PowerShell produzca un error al ejecutar la función o el cmdlet.

Cómo

Especifique un valor para el HelpMessage atributo .

Ejemplo

Incorrecto

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
}

Correcto

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

    $Param
}