有没有一种方法可以为Commandlet创建可重用的帮助文档

Question

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

<#
    .SYNOPSIS
        Does something

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

问题是，每当我对文档进行较小的更改时，我都必须对其进行跟踪并在各处进行更改。 有没有办法创建一些更“可重用”的东西？ 与之类似，我只在一处更新文档，这些更改反映在各处。

Answer 1

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

这是帮助脚本的示例： Mdbc.dll-Help.ps1 。 此模块有很多具有类似参数的cmdlet。 您可以看到在开始时，脚本将常见的帮助片段定义为变量。 以后将在多个地方使用它们。