c# - 如何在 C# 中为 cmdlet 添加概要/摘要？

Question

假设你正在写一些 PSCmdLet在 C# 中:

/// <summary>
/// Get a stack overflow exception.
/// </summary>
[Cmdlet(VerbsCommon.Join, "StackOverflow")]
[OutputType(typeof(OverflowException))]
public class JoinStackOverflow : PSCmdlet {
  protected override void ProcessRecord() {
    throw new OverflowException("stack");
  }
}

如果将上述定义的模块加载到 PowerShell 中，命令 help Join-StackOverflow 将返回以下内容:

NAME
  Join-StackOverflow

SYNTAX
  Join-StackOverflow  [<CommonParameters>]

ALIASES
  None

REMARKS
  None

如何为此 cmdlet 添加概要/摘要，例如与 Get-Process 相同:

NAME
  Get-Process

SYNOPSIS
  Gets the processes that are running on the local computer or a remote computer.

...

Answer 1

Cmdlet 帮助通常位于附属 XML 文件中。假设 cmdlet 在模块 MyModule.dll 中，帮助文件通常在 MyModule\en-US\MyModule.dll-help.xml

帮助 XML 是所谓的 MAML 格式。为了避免每次手动编写它我创建了一个工具(脚本库)Helps .它为 cmdlet 生成模板帮助脚本，看起来有点类似于帮助。这是一个 example .然后，在填充空白 ( example ) 之后，调用另一个 Helps 命令将此脚本转换为 MAML XML。

附言网络上还有其他帮助工具。我尝试了其中的几个，然后决定创建我自己的。