Colocar a ajuda baseada em comentários em funções

Este tópico explica onde colocar ajuda baseada em comentários para uma função para que o cmdlet Get-Help associe o tópico de ajuda baseado em comentários à função correta.

Onde colocar Comment-Based ajuda para uma função

• No início do corpo da função.

• No fim do corpo da função.

• Antes da palavra-chave Function. Quando a função está em um script ou módulo de script, não pode haver mais de uma linha em branco entre a última linha da ajuda baseada em comentário e a palavra-chave Function. Caso contrário, Get-Help associa a ajuda ao script, não à função.

Exemplos de posicionamento de ajuda em uma função

Os exemplos a seguir mostram cada uma das três opções de posicionamento para ajuda baseada em comentários para uma função.

Ajuda no início de um corpo de função

O exemplo a seguir mostra o comentário baseado no início de um corpo de função.

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

    Get-Process powershell
}

Ajuda no final de um corpo de função

O exemplo a seguir mostra o comentário baseado no final de um corpo de função.

function MyFunction
{
    Get-Process powershell

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

Ajuda antes da palavra-chave da função

Os exemplos a seguir mostram comentários baseados na linha antes da palavra-chave da função.

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