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

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

関数の Comment-Based ヘルプを配置する場所

• 関数本体の先頭。

• 関数本体の末尾。

• Function キーワードの前。 関数がスクリプトまたはスクリプト モジュール内にある場合、コメント ベースのヘルプの最後の行と Function キーワードの間に複数の空白行を指定することはできません。 それ以外の場合、Get-Help はヘルプを関数ではなくスクリプトに関連付けます。

関数内のヘルプ配置の例

次の例は、関数のコメント ベースのヘルプの 3 つの配置オプションのそれぞれを示しています。

関数本体の先頭でのヘルプ

次の例は、関数本体の先頭にあるコメントベースを示しています。

function MyProcess
{
    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>

    Get-Process powershell
}

関数本体の最後のヘルプ

次の例は、関数本体の末尾にあるコメントベースを示しています。

function MyFunction
{
    Get-Process powershell

    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>
}

関数キーワードの前のヘルプ

次の例は、function キーワードの前の行に基づくコメントを示しています。

<#
    .DESCRIPTION
    The MyProcess function gets the Windows PowerShell process.
#>
function MyFunction { Get-Process powershell}