Comment faire pour obtenir le Cmdlet C# Paramètre HelpMessage à afficher dans `Get-Help`

Question

J'ai lancé une applet de commande PowerShell et je souhaite fournir le message d'aide pour un paramètre. Je l'ai essayé d'utiliser ParameterAttribute.HelpMessage pour cela:

[Cmdlet(VerbsCommon.Get, "Workspace", SupportsShouldProcess = true)] 
public class GetWorkspace : PSCmdlet 
{ 
    [Parameter(
     Mandatory = true, 
     Position = 1, 
     HelpMessage = "The path to the root directory of the workspace.")] 
    public string Path { get; set; } 

    protected override void ProcessRecord() 
    { 
     base.ProcessRecord(); 
    } 
} 

Mais quand j'utilise la commande PowerShell Get-Help, il ne montre pas le HelpMessage pour le paramètre:

get-help Get-Workspace -det 

NAME 
    Get-Workspace 

SYNTAX 
    Get-Workspace [-Path] <string> [-WhatIf] [-Confirm] [<CommonParameters>] 


PARAMETERS 
    -Confirm 

    -Path <string> 

    -WhatIf 

    <CommonParameters> 
     This cmdlet supports the common parameters: Verbose, Debug, 
     ErrorAction, ErrorVariable, WarningAction, WarningVariable, 
     OutBuffer, PipelineVariable, and OutVariable. For more information, see 
     about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). 


ALIASES 
    None 


REMARKS 
    None 

Lors de l'écriture d'une applet de commande dans le script PowerShell I peut ajouter un message d'aide pour les paramètres en utilisant cette syntaxe:

<# 
.Parameter Path 
The local path to the root folder of the workspace. 
#> 

Mais ce qui est l'équivalent dans une applet de commande C#?

Answer 1

Vous le faites absolument bien!

Vous avez juste besoin d'inspecter la vue -Full ou obtenir de l'aide pour le paramètre spécifique avec -Parameter:

PS C:\> Get-Help Get-Workspace -Parameter Path 

-Path <string> 
    The path to the root directory of the workspace. 

    Required?     true 
    Position?     1 
    Accept pipeline input?  false 
    Parameter set name   (All) 
    Aliases      None 
    Dynamic?      false