Microsoft.PowerShell.PlatyPS （PlatyPS） 模块允许你以 Markdown 格式创建命令文档，然后将 Markdown 文件转换为 MAML 格式，而不是手写 MAML 帮助文件。 PlatyPS 为模块中的每个命令创建一个 Markdown 模板。 PlatyPS 不会为您编写帮助内容。 您必须在模板中填写描述命令、参数、示例和其他支持信息的内容。
创建 MAML 帮助内容包括以下步骤：
- 为您的模块创建 Markdown 模板文件。
- 编辑 Markdown 文件以添加内容。
- 测试 Markdown 文件以确保结构正确。
- 将 Markdown 文件转换为 MAML 格式并发布帮助
本文介绍前三个步骤。
先决条件
在开始之前，必须从 PowerShell 库安装 Microsoft.PowerShell.PlatyPS 模块。 您还必须安装要记录的模块。
使用以下命令安装 PlatyPS：
Install-PSResource -Name Microsoft.PowerShell.PlatyPS
步骤 1 - 创建 Markdown 模板文件
有两种类型的 Markdown 文件可以为模块创建：
- 命令帮助文件 - 每个命令一个文件。
- 模块文件 - 包含有关模块的元数据并列出模块中的命令。
如果要为模块创建 MAML 内容，则需要这两种文件类型。
运行以下命令创建 Markdown 文件：
$newMarkdownCommandHelpSplat = @{
ModuleInfo = Get-Module -Name 'YourModuleName'
OutputFolder = './docs'
WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat
该 New-MarkdownCommandHelp 命令在当前目录中创建一个名为的 ./docs/YourModuleName 文件夹。 该文件夹包含模块中每个命令的 Markdown 文件，以及名为 YourModuleName.md的模块文件。 模块文件包含有关模块的元数据，并列出每个命令及其概要描述。 该文件可以转换为 HTML，以用作文档网站上模块的索引页面。
首次创建模块文件时，没有命令的概要说明。 Markdown 文件包含占位符，您必须将其替换为概要说明。
如果省略 WithModulePage 参数，则不会创建模块文件。 在编写概要说明后，您可以稍后通过运行命令 New-MarkdownModuleFile 来创建模块文件。 例如：
Measure-PlatyPSMarkdown -Path ./docs/YourModuleName/*.md |
Where-Object Filetype -match 'CommandHelp' |
Import-MarkdownCommandHelp -Path {$_.FilePath} |
New-MarkdownModuleFile -OutputFolder ./docs -Force
此命令在文件夹中 ./docs/YourModuleName 创建模块文件。 该 -Force 参数覆盖任何现有模块文件。 如果已在命令文件中填写了概要说明，则这些说明将包含在模块文件中。
有关这些命令的详细信息，请参阅以下文章：
