次の方法で共有

ヘルプ キーワードの Comment-Based

このトピックでは、コメントベースのヘルプのキーワードの一覧と説明を行います。

Comment-Based ヘルプのキーワード

有効なコメント ベースのヘルプ キーワードを次に示します。 これらは、通常、ヘルプ トピックに表示される順序と目的の用途に従って一覧表示されます。 これらのキーワードはコメント ベースのヘルプで任意の順序で表示でき、大文字と小文字は区別されません。

.EXTERNALHELP キーワードは、他のすべてのコメント ベースのヘルプ キーワードよりも優先されることに注意してください。 .EXTERNALHELP が存在する場合、Get-Help コマンドレットは、キーワードの値に一致するヘルプ ファイルが見つからない場合でも、コメントベースのヘルプを表示しません。

.SYNOPSIS

関数またはスクリプトの簡単な説明。 このキーワードは、各トピックで 1 回だけ使用できます。

.DESCRIPTION

関数またはスクリプトの詳細な説明。 このキーワードは、各トピックで 1 回だけ使用できます。

.PARAMETER <Parameter-Name>

パラメーターの説明。 各パラメーターの .PARAMETER キーワードを関数またはスクリプトに含めることができます。

.PARAMETER キーワードはコメント ブロック内の任意の順序で表示できますが、パラメーターが param ステートメントまたは関数宣言に表示される順序によって、ヘルプ トピックでのパラメーターの表示順序が決まります。 ヘルプ トピックのパラメーターの順序を変更するには、param ステートメントまたは関数宣言のパラメーターの順序を変更します。

パラメーター変数名の直前の param ステートメントにコメントを配置して、パラメーターの説明を指定することもできます。 param ステートメント コメントと .PARAMETER キーワードの両方を使用する場合、.PARAMETER キーワードに関連付けられている説明が使用され、param ステートメント コメントは無視されます。

.EXAMPLE

関数またはスクリプトを使用するサンプル コマンド。必要に応じて、サンプル出力と説明が続きます。 各例でこのキーワードを繰り返します。

.INPUTS

関数またはスクリプトにパイプ処理できる .NET 型のオブジェクト。 入力オブジェクトの説明を含めることもできます。 入力の種類ごとにこのキーワードを繰り返します。

.OUTPUTS

コマンドレットが返すオブジェクトの .NET 型。 返されるオブジェクトの説明を含めることもできます。 出力の種類ごとにこのキーワードを繰り返します。

.NOTES

関数またはスクリプトに関する追加情報。

関連トピックの名前。 関連トピックごとにこのキーワードを繰り返します。 このコンテンツは、ヘルプ トピックの [関連リンク] セクションに表示されます。

.LINK キーワード コンテンツには、同じヘルプ トピックのオンライン バージョンへの URI (Uniform Resource Identifier) を含めることもできます。 オンライン バージョンは、の Get-Help パラメーターを使用すると開きます。 URI は、 http または httpsで始まる必要があります。

.COMPONENT

関数またはスクリプトが使用するテクノロジまたは機能の名前、または関連するテクノロジまたは機能の名前。 Component の Get-Help パラメーターは、この値を使用して、Get-Helpによって返される検索結果をフィルター処理します。

.ROLE

ヘルプ トピックのユーザー ロールの名前。 Role の Get-Help パラメーターは、この値を使用して、Get-Helpによって返される検索結果をフィルター処理します。

.FUNCTIONALITY

関数の使用目的を説明するキーワード。 Functionality の Get-Help パラメーターは、この値を使用して、Get-Helpによって返される検索結果をフィルター処理します。

.FORWARDHELPTARGETNAME <Command-Name>

指定したコマンドのヘルプ トピックにリダイレクトします。 ユーザーは、関数、スクリプト、コマンドレット、プロバイダーのヘルプ コンテンツなど、任意のヘルプ トピックにリダイレクトできます。

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

.FORWARDHELPTARGETNAME内の項目のヘルプ カテゴリを指定します。 有効な値は、Alias、Cmdlet、HelpFile、Function、Provider、General、FAQ、Glossary、ScriptCommand、ExternalScript、Filter、または Allです。 同じ名前のコマンドがある場合に競合を回避するには、このキーワードを使用します。

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

ヘルプ トピックを含むセッションを指定します。 PSSession オブジェクトを含む変数を入力します。 このキーワードは、[Export-PSSession][09] コマンドレットで、エクスポートされたコマンドのヘルプ コンテンツを検索するために使用されます。

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

スクリプトまたは関数の XML ベースのヘルプ ファイルを指定します。

# .EXTERNALHELP <XML Help File>

関数またはスクリプトが XML ファイルに記述されている場合は、.EXTERNALHELP キーワードが必要です。 このキーワードがないと、Get-Help 関数またはスクリプトの XML ベースのヘルプ ファイルが見つかりません。

.EXTERNALHELP キーワードは、他のコメント ベースのヘルプ キーワードよりも優先されます。 .EXTERNALHELP が存在する場合、Get-Help は、.EXTERNALHELP キーワードの値と一致するヘルプ トピックが見つからない場合でも、コメントベースのヘルプを表示しません。

関数がモジュールによってエクスポートされる場合は、.EXTERNALHELP キーワードの値をパスのないファイル名に設定します。 Get-Help モジュール ディレクトリの言語固有のサブディレクトリで、指定したファイル名を検索します。 関数の XML ベースのヘルプ ファイルの名前には要件はありませんが、次の形式を使用することをお勧めします。

<ScriptModule.psm1>-help.xml

関数がモジュールに含まれていない場合は、XML ベースのヘルプ ファイルへのパスを含めます。 値にパスが含まれ、パスに UI カルチャ固有のサブディレクトリが含まれている場合、Get-Help は、モジュール ディレクトリと同様に、Windows 用に確立された言語フォールバック標準に従って、スクリプトまたは関数の名前を持つ XML ファイルを再帰的に検索します。

コマンドレット ヘルプの XML ベースのヘルプ ファイル形式の詳細については、「コマンドレット ヘルプを記述する方法」を参照してください。