PowerShell 中的帮助类型

PowerShell 帮助系统支持两种帮助。

  • 描述概念和用例方案的概念性帮助文章。
  • 描述 cmdlet、函数和脚本的语法和用法的命令帮助文章。

PlatyPS 模块可帮助你为模块创建和打包 PowerShell 帮助文件。

概念(“关于”)帮助文本文件

概念性(“关于”)帮助文章描述了模块及其成员(如命令和变量),并解释了如何一起使用这些成员来执行任务。 关于帮助文章是纯文本文件。 PlatyPS 模块不可以帮助您创建这些文件,但它可以将它们与支持可更新帮助的模块的命令帮助文件打包。

有关创建概念性帮助文章的详细信息,请参阅 编写 PowerShell 模块的帮助

命令帮助文章

命令帮助文章介绍了 cmdlet、函数和脚本的语法和用法。 命令帮助可以通过两种方式实现:

  • 嵌入在脚本或函数中的基于注释的帮助。
  • 存储在外部 XML 文件中的基于 XML 的帮助。

基于注释的命令帮助

对于 PowerShell 脚本和函数,可以直接在脚本或函数的源文件中编写基于注释的帮助。 基于注释的帮助使用 PowerShell 识别的特殊注释关键字。 PowerShell 从脚本或函数中提取基于注释的帮助,以便 cmdlet 进行 Get-Help 演示。 有关编写基于注释的帮助文章的详细信息,请参阅以下文章:

基于 XML 的命令帮助

PowerShell 帮助系统还支持以 Microsoft 帮助标记语言 (MAML) 格式编写的帮助文件。 MAML 是一种基于 XML 的架构,用于创建帮助文档。 MAML 是为二进制模块中实现的 cmdlet 创建帮助的唯一方法。 此外,这是支持可更新帮助的模块所需的格式。

可以使用 MAML 为脚本和函数创建帮助。 但是,当两种类型的帮助都存在时,基于注释的帮助优先于基于 XML 的帮助,除非您使用 .EXTERNALHELP comment 关键字。 当注释关键字存在时.EXTERNALHELP,它优先于基于注释的帮助,即使找不到注释中Get-Help指定的帮助文件也是如此.EXTERNALHELP。 有关编写基于 XML 的帮助文章的详细信息,请参阅 如何创建 cmdlet 帮助文件

手写 MAML 很乏味且容易出错。 PlatyPS 模块允许您用 Markdown 编写命令文档,然后将其编译为 MAML 格式。 有关使用 PlatyPS 的信息,请参阅 使用 PlatyPS 创建新的 Markdown 帮助