Vložení nápovědy založené na komentářích do funkcí

Toto téma vysvětluje, kam umístit nápovědu založenou na komentářích pro funkci, aby rutina Get-Help přidružila téma nápovědy založené na komentáři ke správné funkci.

Kde umístit Comment-Based nápovědu pro funkci

• Na začátku těla funkce.

• Na konci těla funkce.

• Před klíčovým slovem Function. Pokud je funkce ve skriptu nebo modulu skriptu, nemůže existovat více než jeden prázdný řádek mezi posledním řádkem nápovědy založené na komentáři a klíčovým slovem Function. Jinak Get-Help přidruží nápovědu ke skriptu, ne k funkci.

Příklady umístění nápovědy ve funkci

Následující příklady ukazují každou ze tří možností umístění nápovědy pro funkci založenou na komentářích.

Nápověda na začátku těla funkce

Následující příklad ukazuje komentář založený na začátku těla funkce.

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

    Get-Process powershell
}

Nápověda na konci těla funkce

Následující příklad ukazuje komentář založený na konci těla funkce.

function MyFunction
{
    Get-Process powershell

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

Nápověda před klíčovým slovem funkce

Následující příklady ukazují komentář založený na řádku před klíčovým slovem funkce.

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