スクリプトにコメントベースのヘルプを配置する

このトピックでは、スクリプトのコメントベースのヘルプを配置する場所について説明します。これにより、Get-Help コマンドレットは、スクリプト内の関数ではなく、コメントベースのヘルプトピックをスクリプトに関連付けます。

スクリプトの Comment-Based ヘルプを配置する場所

スクリプトファイルの先頭。

スクリプトヘルプの前には、コメントと空白行のみを使用できます。
スクリプトファイルの末尾。

スクリプト本体の最初の項目 (ヘルプの後) が関数宣言である場合は、スクリプトヘルプの末尾と関数宣言の間に少なくとも 2 つの空白行が必要です。それ以外の場合、ヘルプはスクリプトのヘルプではなく、関数のヘルプとして解釈されます。

次の例は、スクリプトのコメントベースのヘルプの配置オプションを示しています。

次の例は、スクリプトの先頭にあるコメントベースを示しています。

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>

param [string]$ComputerName
...

次の例は、スクリプトの末尾にあるコメントベースを示しています。

...
function Ping { Test-Connection -ComputerName $ComputerName }

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>