次の方法で共有

ヘルプ キーワードの 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

関数またはスクリプトにパイプ処理できる Microsoft .NET Framework 型のオブジェクト。 入力オブジェクトの説明を含めることもできます。

.OUTPUTS

コマンドレットが返すオブジェクトの .NET Framework 型。 返されるオブジェクトの説明を含めることもできます。

.NOTES

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

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

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

.COMPONENT

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

.ROLE

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

.FUNCTIONALITY

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

.FORWARDHELPTARGETNAME <Command-Name>

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

.FORWARDHELPCATEGORY <Category>

.FORWARDHELPTARGETNAME内のアイテムのヘルプ カテゴリを指定します。 同じ名前のコマンドがある場合に競合を回避するには、このキーワードを使用します。

有効な値は次のとおりです。

  • 別名
  • コマンドレット
  • HelpFile
  • Function
  • Provider
  • General
  • FAQ
  • Glossary
  • ScriptCommand
  • ExternalScript
  • フィルター
  • すべての

.REMOTEHELPRUNSPACE <PSSession-variable>

ヘルプ トピックを含むセッションを指定します。 PSSession を含む変数を入力します。 このキーワードは、エクスポートされたコマンドのヘルプ トピックを検索するために、Export-PSSession コマンドレットによって使用されます。

.EXTERNALHELP <XML Help File>

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

.EXTERNALHELP キーワードは、Get-Help コマンドレットに、XML ベースのファイル内のスクリプトまたは関数のヘルプを取得するように指示します。 スクリプトまたは関数に XML ベースのヘルプ ファイルを使用する場合は、.EXTERNALHELP キーワードが必要です。 これを指定しないと、Get-Help 関数またはスクリプトのヘルプ ファイルが見つかりません。

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

スクリプト モジュールによって関数がエクスポートされる場合、.EXTERNALHELP の値はパスのないファイル名にする必要があります。 Get-Help モジュール ディレクトリのロケール固有のサブディレクトリでファイルを検索します。 ファイル名の要件はありませんが、ベスト プラクティスは、次のファイル名形式を使用することです: <ScriptModule>.psm1-help.xml.

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

コマンドレットのヘルプ XML ベースのヘルプ ファイル形式の詳細については、「Windows PowerShell コマンドレットヘルプの作成 を参照してください。