コメント ベースのヘルプのキーワード
このトピックでは、コメント ベースのヘルプのキーワードの一覧と説明を示します。
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
関連トピックの名前。 関連トピックごとにこのキーワードを繰り返します。 このコンテンツは、ヘルプ トピックの [関連リンク] セクションに表示されます。
キーワード .LINK コンテンツには、同じヘルプ トピックのオンライン Uniform Resource Identifier (URI) を含め指定できます。 の パラメーターを使用すると、オンライン バージョンが Online 開きます 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>
指定したコマンドのヘルプ トピックにリダイレクトします。 関数、スクリプト、コマンドレット、プロバイダーのヘルプ トピックなど、任意のヘルプ トピックにユーザーをリダイレクトできます。
.FORWARDHELPCATEGORY <Category>
内の項目のヘルプ カテゴリを指定します .FORWARDHELPTARGETNAME。 同じ名前のコマンドがある場合に競合を回避するには、このキーワードを使用します。
有効な値は次のとおりです。
- エイリアス
- コマンドレット
- HelpFile
- Function
- Provider
- General
- FAQ
- Glossary
- ScriptCommand
- ExternalScript
- フィルター
- All
.REMOTEHELPRUNSPACE <PSSession-variable>
ヘルプ トピックを含むセッションを指定します。 PSSession を含む変数を入力します。 このキーワードは、エクスポートされたコマンドの Export-PSSession ヘルプ トピックを検索するために コマンドレットによって使用されます。
.EXTERNALHELP <XML Help File>
スクリプトまたは関数の XML ベースのヘルプ ファイルのパスや名前を指定します。
キーワード .EXTERNALHELP は、 XML ベースのファイル内 のスクリプトまたは関数のヘルプを取得するために Get-Help コマンドレットに指示します。 キーワード .EXTERNALHELP は、スクリプトまたは関数に XML ベースのヘルプ ファイルを使用する場合に必要です。 それがない場合 Get-Help 、 は関数またはスクリプトのヘルプ ファイルを見つけ出しません。
キーワード .EXTERNALHELP は、他のすべてのコメント ベースのヘルプ キーワードよりも優先されます。 が .EXTERNALHELP 存在する場合、 Get-Help コマンドレットは、キーワードの値と一致するヘルプ ファイルが見つからなくても、コメントベースのヘルプを表示します。
関数がスクリプト モジュールによってエクスポートされる場合、 .EXTERNALHELP の値はパスのないファイル名である必要があります。 Get-Help は、モジュール ディレクトリのロケール固有のサブディレクトリ内のファイルを検索します。 ファイル名の要件はありません。ただし、ベスト プラクティスは、次のファイル名形式を使用することです。 <ScriptModule>.psm1-help.xml
関数がモジュールに関連付けされていない場合は、 キーワードの値にパスとファイル名を含める必要 .EXTERNALHELP があります。 XML ファイルへの指定されたパスに UI Get-Help カルチャ固有のサブディレクトリが含まれている場合は、すべての XML ベースのヘルプ トピックの場合と同様に、Windows に対して確立された言語フォールバック標準に従って、スクリプトまたは関数の名前を持つ XML ファイルを再帰的に検索します。
コマンドレットのヘルプ XML ベースのヘルプ ファイル形式の詳細については、「 Writing Windows PowerShell Cmdlet Help」を参照してください。
フィードバック
フィードバックの送信と表示