Help op basis van opmerkingen in functies plaatsen

In dit onderwerp wordt uitgelegd waar u hulp op basis van opmerkingen kunt plaatsen voor een functie, zodat de Get-Help cmdlet het helponderwerp op basis van opmerkingen koppelt aan de juiste functie.

Waar Comment-Based Help voor een functie plaatsen

• Aan het begin van de hoofdtekst van de functie.

• Aan het einde van de hoofdtekst van de functie.

• Voor het Function trefwoord. Wanneer de functie zich in een script- of scriptmodule bevindt, kan er niet meer dan één lege regel zijn tussen de laatste regel van de help op basis van opmerkingen en het Function trefwoord. Anders koppelt Get-Help de help aan het script, niet aan de functie.

Voorbeelden van Help-plaatsing in een functie

In de volgende voorbeelden ziet u elk van de drie plaatsingsopties voor hulp op basis van opmerkingen voor een functie.

Help aan het begin van een functietekst

In het volgende voorbeeld ziet u op basis van opmerkingen aan het begin van een functietekst.

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

    Get-Process powershell
}

Help aan het einde van een functietekst

In het volgende voorbeeld ziet u opmerkingen aan het einde van een hoofdtekst van een functie.

function MyFunction
{
    Get-Process powershell

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

Help vóór het trefwoord functie

In de volgende voorbeelden ziet u opmerkingen op basis van de regel vóór het trefwoord van de functie.

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