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 參數會覆寫任何現有的模組檔案。 如果您已在指令檔中填寫概要說明，則這些說明會包含在模組檔中。
有關這些命令的更多資訊，請參閱以下文章：
