¿Cómo puedo hacer que aparezcan los mensajes de ayuda para mis parámetros de script de Powershell?

Question

¿Cómo puedo hacer que aparezcan los mensajes de ayuda para mis parámetros de script de Powershell?

Tengo un script de powershell (setup.ps1), que usamos como punto de entrada para nuestros scripts de configuración del entorno de desarrollo. Toma un parámetro:

param(
    [Parameter(Position=0,HelpMessage="The targets to run.")]
    [Alias("t")]
    [string[]]
    $Targets = "Help"
)

Cuando corro

PS > get-help .\setup.ps1 -detailed

En la sección parámetros, mi mensaje de ayuda no aparece:

PARAMETERS
    -Targets <String[]>

¿Qué debo hacer para que se muestren mis mensajes de ayuda de parámetros?

45

powershell powershell-v2.0

Author: Aaron Jensen, 2011-03-08

Source

2 answers

Al parecer, si tiene un encabezado de ayuda definido, solo puede usar un comentario ( # ) detrás del parámetro (en este ejemplo: #Los objetivos a correr.):

<#
.SYNOPSIS
    .
.DESCRIPTION
    .
.PARAMETER Path
    The path to the .
.PARAMETER LiteralPath
    Specifies a path to one or more locations. Unlike Path, the value of 
    LiteralPath is used exactly as it is typed. No characters are interpreted 
    as wildcards. If the path includes escape characters, enclose it in single
    quotation marks. Single quotation marks tell Windows PowerShell not to 
    interpret any characters as escape sequences.
#>

Param(
    [String]$Targets = "Help"   #The targets to run.
)

Resultados en:

PS C:\> Get-help .\Setup.ps1 -Detailed

NAME
    C:\Setup.ps1

SYNOPSIS
    .


SYNTAX
    C:\Setup.ps1 [[-Targets] <String>] [<CommonParameters>]


DESCRIPTION
    .


PARAMETERS
    -Targets <String>
        The targets to run.

15

Author: iRon,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2015-05-21 15:24:34

score 76 · Accepted Answer

Coloque un cierto estilo de comentario en la parte superior del archivo que puede decodificar el sistema de ayuda de PowerShell. He aquí un ejemplo:

<#
.SYNOPSIS
    .
.DESCRIPTION
    .
.PARAMETER Path
    The path to the .
.PARAMETER LiteralPath
    Specifies a path to one or more locations. Unlike Path, the value of 
    LiteralPath is used exactly as it is typed. No characters are interpreted 
    as wildcards. If the path includes escape characters, enclose it in single
    quotation marks. Single quotation marks tell Windows PowerShell not to 
    interpret any characters as escape sequences.
.EXAMPLE
    C:\PS> 
    <Description of example>
.NOTES
    Author: Keith Hill
    Date:   June 28, 2010    
#>
function AdvFuncToProcessPaths
{
    [CmdletBinding(DefaultParameterSetName="Path")]
    param(
        [Parameter(Mandatory=$true, Position=0, ParameterSetName="Path", 
                   ValueFromPipeline=$true, 
                   ValueFromPipelineByPropertyName=$true,
                   HelpMessage="Path to ...")]
        [ValidateNotNullOrEmpty()]
        [string[]]
        $Path,

        [Alias("PSPath")]
        [Parameter(Mandatory=$true, Position=0, ParameterSetName="LiteralPath", 
                   ValueFromPipelineByPropertyName=$true,
                   HelpMessage="Path to ...")]
        [ValidateNotNullOrEmpty()]
        [string[]]
        $LiteralPath
    )
    ...

Para obtener más información, consulte el tema de ayuda - man about_comment_based_help.