コメントベースのヘルプ トピックを記述する

特別なヘルプコメントキーワードを使用して、関数およびスクリプトのコメントベースのヘルプトピックを記述できます。

コマンドレットでは、 Get-Help XML ファイルから生成されたコマンドレットヘルプトピックを表示するのと同じ形式で、コメントベースのヘルプを表示します。 ユーザーは、のすべてのパラメーター Get-Help (Detailed、Full、Example、Online など) を使用して、関数やスクリプトのヘルプを表示できます。

また、スクリプトや関数の XML ベースのヘルプトピックを記述し、ヘルプコメントキーワードを使用して、XML ベースのトピックやその他のトピックにユーザーをリダイレクトすることもできます。

このセクションの内容

Comment-Based ヘルプの構文 コメントベースのヘルプの構文について説明します。

コメントベースのヘルプキーワード コメントベースのヘルプのキーワードの一覧を示します。

関数に Comment-Based ヘルプを配置 する関数のコメントベースのヘルプを配置する場所を示します。

スクリプトに Comment-Based ヘルプを配置 するスクリプトのコメントベースのヘルプを配置する場所を示します。