米Microsoftは、Get-Helpで表示されるPowerShellのヘルプを作成するためのツールの最新プレビュー版となる、「PlatyPS 2.0.0-Preview1」を5月20日(現地時間)に公開した。
PlatyPSは、マークダウンをサポートするエディタまたはツールで、PowerShellヘルプの文書化を可能にするソリューションとして提供されており、非常に大規模なクローズドソースやバイナリモジュールといった、コードベースからドキュメントを抽象化することが望ましい複雑なシナリオのPoweShellドキュメント化に適している。
ドキュメント生成にあたって、ソースアクセスは不要で、PowerShell、SCCM、Windows、その他のサポートされているモジュール用のヘルプファイルを生成できる。また、モジュールに付属するヘルプの作成にも対応している。
今回、リリースされた「PlatyPS 2.0.0-Preview1」では、マークダウンを解析するMarkdigを利用してC#で書き直したほか、New-MarkdownHelpとGet-MarkdownMetadataの更新が行われた。なお、「PlatyPS 2.0.0」ではバージョン5.1以降のWindows PowerShell、バージョン7.0以降のPowerShellがサポートされている。
この記事は参考になりましたか?
- この記事の著者
-
CodeZine編集部(コードジンヘンシュウブ)
CodeZineは、株式会社翔泳社が運営するソフトウェア開発者向けのWebメディアです。「デベロッパーの成長と課題解決に貢献するメディア」をコンセプトに、現場で役立つ最新情報を日々お届けします。
※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です