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

このトピックでは、スクリプトにコメント ベースのヘルプを配置する場所について説明します。これにより、コマンドレットはコメントベースのヘルプ トピックをスクリプト内の関数に関連付け、スクリプト内の関数には関連付け 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.
#>