c# - 如何让 C# Cmdlet 参数 HelpMessage 显示在 `Get-Help` 中

Question

我已经启动了一个 PowerShell cmdlet，并想为一个参数提供帮助消息。我试过为此使用 ParameterAttribute.HelpMessage:

[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();
    }
}

但是当我使用 PowerShell Get-Help 命令时，它没有显示参数的 HelpMessage:

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

在 PowerShell 脚本中编写 cmdlet 时，我可以使用以下语法为参数添加帮助消息:

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

但是 C# cmdlet 中的等价物是什么？

Answer 1

你做的绝对正确!

您只需要检查 -Full View 或使用 -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