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

このトピックでは、コマンドレットによって 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}