Lägga till kommentarsbaserad hjälp i funktioner

Det här avsnittet beskriver var du placerar kommentarsbaserad hjälp för en funktion så att cmdleten Get-Help associerar det kommentarsbaserade hjälpavsnittet med rätt funktion.

Var du kan placera Comment-Based hjälp för en funktion

• I början av funktionstexten.

• I slutet av funktionstexten.

• Före nyckelordet Function . När funktionen finns i en skript- eller skriptmodul kan det inte finnas mer än en tom rad mellan den sista raden i den kommentarsbaserade hjälpen och nyckelordet Function. Annars associerar Get-Help hjälpen med skriptet, inte med funktionen.

Exempel på hjälpplacering i en funktion

I följande exempel visas var och en av de tre placeringsalternativen för kommentarsbaserad hjälp för en funktion.

Hjälp i början av en funktionstext

I följande exempel visas kommentarsbaserad i början av en funktionstext.

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

    Get-Process powershell
}

Hjälp i slutet av en funktionstext

I följande exempel visas kommentarsbaserad i slutet av en funktionstext.

function MyFunction
{
    Get-Process powershell

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

Hjälp före nyckelordet Funktion

I följande exempel visas kommentarsbaserad på raden före nyckelordet för funktionen.

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