Inserimento della Guida basata sui commenti nelle funzioni

In questo argomento viene illustrato dove inserire la Guida basata su commenti per una funzione in modo che il cmdlet Get-Help associ l'argomento della Guida basata su commenti alla funzione corretta.

Posizione della Guida Comment-Based per una funzione

• All'inizio del corpo della funzione.

• Alla fine del corpo della funzione.

• Prima della parola chiave Function. Quando la funzione si trova in un modulo script o script, non può essere presente più di una riga vuota tra l'ultima riga della Guida basata su commenti e la parola chiave Function. In caso contrario, Get-Help associa la Guida allo script, non alla funzione .

Esempi di posizionamento della Guida in una funzione

Gli esempi seguenti mostrano ognuna delle tre opzioni di posizionamento per la Guida basata su commenti per una funzione.

Guida all'inizio di un corpo di una funzione

Nell'esempio seguente viene illustrato in base ai commenti all'inizio di un corpo di una funzione.

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

    Get-Process powershell
}

Guida alla fine di un corpo di una funzione

Nell'esempio seguente viene illustrato in base ai commenti alla fine di un corpo di una funzione.

function MyFunction
{
    Get-Process powershell

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

Guida prima della parola chiave function

Negli esempi seguenti viene illustrato un commento basato sulla riga prima della parola chiave function.

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