コマンドレット用の再利用可能なヘルプドキュメントを作成する方法はありますか

Question

多くのコマンドレットを持つカスタムPowerShellモジュールがあります。いくつかのコマンドレットは、同じ正確なパラメータを使用します。私は例えば、私のコマンドレットを文書にコメントベースのヘルプを使用しています。：

<# 
    .SYNOPSIS 
     Does something 

    .PARAMETER CommonParameter 
     This documentation is copied and pasted across multiple cmdlets. 
#> 

問題は、私はそれを追跡し、どこでもそれを変更する必要があるドキュメントへの軽微な変更を加えるたびということです。もう少し「再利用可能」なものを作り出す方法はありますか？のように、私は1つの場所でドキュメントを更新し、それらの変更はどこにでも反映されます。

Answer 1

生成されたXMLファイルで外部ヘルプを使用しても構わない場合は、 をHelpsに表示してください。そのヘルプスクリプトは実際には PowerShellスクリプトなので、再利用可能な部分を変数として定義して使用することができます。

ヘルプスクリプトの例を次に示します。Mdbc.dll-Help.ps1。 このモジュールには、類似のパラメータを持つ多くのコマンドレットがあります。あなたは で始まり、スクリプトは共通のヘルプを変数として定義していることが分かります。彼らは後でいくつかの場所で使用される です。