Umieszczanie pomocy opartej na komentarzach w funkcjach

W tym temacie wyjaśniono, gdzie umieścić pomoc opartą na komentarzach dla funkcji, aby polecenie cmdlet Get-Help kojarzyło temat pomocy opartej na komentarzach z poprawną funkcją.

Gdzie umieścić Comment-Based Pomoc dla funkcji

• Na początku treści funkcji.

• Na końcu treści funkcji.

• Przed słowem kluczowym Function. Gdy funkcja znajduje się w module skryptu lub skryptu, nie może istnieć więcej niż jeden pusty wiersz między ostatnim wierszem pomocy opartej na komentarzach a słowem kluczowym Function. W przeciwnym razie Get-Help kojarzy pomoc ze skryptem, a nie z funkcją.

Przykłady umieszczania pomocy w funkcji

W poniższych przykładach przedstawiono każdą z trzech opcji umieszczania dla pomocy opartej na komentarzach dla funkcji.

Pomoc na początku treści funkcji

W poniższym przykładzie pokazano komentarz na początku treści funkcji.

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

    Get-Process powershell
}

Pomoc na końcu treści funkcji

W poniższym przykładzie pokazano komentarz na końcu treści funkcji.

function MyFunction
{
    Get-Process powershell

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

Pomoc przed słowem kluczowym funkcji

W poniższych przykładach przedstawiono komentarz oparty na wierszu przed słowem kluczowym funkcji.

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