PlatyPS 是创建使用 Get-Help显示的 PowerShell 帮助的主要工具。
PowerShell 帮助文件以 Microsoft 帮助标记语言 （MAML） 格式编写。
MAML 为帮助文件的结构定义了 XML 架构。
PlatyPS 有两个主要版本。
-
Microsoft.PowerShell.PlatyPS v1.0.1 是 PlatyPS 的受支持版本。 此版本是 C# 中的完整重写，它利用 markdig 来分析 Markdown。 此版本包括多项改进：
- 提供 PowerShell cmdlet 及其参数的更准确说明
- 提高性能 - 以秒为单位处理 1000 个 Markdown 文件
- 创建可在内存中操作的帮助文件的对象模型
- 提供可以链接在一起以执行复杂操作的 cmdlet
- 定义一个新的 Markdown 架构，其中包含
Get-Help所需的所有元素，以及以前不可用的信息。 - 提供现有 Markdown（使用旧架构）到新对象的自动转换，使你能够导出到新的 Markdown、YAML 或 MAML。
- platyPS v0.14.2 是 PlatyPS 的原始实现。 不再支持此版本。
使用 PlatyPS 的好处
在 PlatyPS 之前，帮助文件是在现有工具和编辑器的有限帮助下手写的。 PlatyPS 允许您在 Markdown 中编写帮助文件，然后将其转换为 MAML，从而简化了该过程。
Markdown 简单易学，在开源社区中广泛使用，并得到包括 Visual Studio Code 在内的许多编辑器的支持。 Markdown 也很容易转换为其他格式，例如 HTML 和 PDF。 可以使用这些 Markdown 文件创建 MAML 帮助文件并为网站创建 HTML 页面。
开始使用 PlatyPS
在开始使用 PlatyPS 之前，应了解 PowerShell 支持的帮助类型。 有关详细信息，请参阅 PowerShell 中的帮助类型。
使用 PlatyPS 创建帮助文件是一个四步过程：
- 创建新的 或 更新现有的 Markdown 帮助文件。
- 编辑 Markdown 帮助 文件以添加说明和示例。
- 测试 Markdown 帮助 文件以确保它们正确呈现。
- 转换并发布 帮助文件。
