Размещение справки на основе комментариев в функциях

В этом разделе объясняется, где разместить справку на основе комментариев для функции, чтобы командлет Get-Help связывает раздел справки на основе комментариев с правильной функцией.

Место Comment-Based справки для функции

• В начале текста функции.

• В конце текста функции.

• Перед ключевым словом Function. Если функция находится в модуле скрипта или скрипта, между последней строкой справки на основе комментариев и ключевым словом Function не может быть более одной пустой строки. В противном случае Get-Help связывает справку с скриптом, а не с функцией.

Примеры размещения справки в функции

В следующих примерах показан каждый из трех вариантов размещения справки на основе комментариев для функции.

Справка в начале текста функции

В следующем примере показан комментарий на основе начала текста функции.

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.
    #>
}

Справка перед ключевым словом функции

В следующих примерах показан комментарий на основе строки перед ключевым словом функции.

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