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 說明 檔案，以確保它們正確呈現。
- 轉換並發佈 說明檔案。
