有没有办法为命令行开关创建可重用的帮助文档

Question

我有一个带有许多cmdlet的自定义PowerShell模块。几个cmdlet采用相同的精确参数。我正在使用基于注释的帮助来记录我的cmdlet，例如：

<#
    .SYNOPSIS
        Does something

    .PARAMETER CommonParameter
        This documentation is copied and pasted across multiple cmdlets.
#>

问题在于，每当我对文档进行微小更改时，我都必须对其进行跟踪并随处更改。有没有办法创造一些更“可重复使用”的东西？同样，我只在一个地方更新文档，这些更改反映在各处。

Answer 1

如果您不介意在生成的XML文件中使用外部帮助，请查看 在Helps。它的帮助脚本实际上就是这样 PowerShell脚本，因此您可以将可重用的片段定义为变量并使用它们。

以下是帮助脚本示例：Mdbc.dll-Help.ps1。 此模块有许多具有类似参数的cmdlet。你可以看到 脚本开头将常用帮助片定义为变量。他们是 稍后在几个地方使用。