Help op basis van opmerkingen in functies plaatsen

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

Waar te plaatsen Comment-Based Help voor een functie

• Aan het begin van de functie-body.

• Aan het einde van de functie-body.

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

Voorbeelden van Help-plaatsing in een functie

In de volgende voorbeelden worden de drie plaatsingsopties voor help op basis van opmerkingen voor een functie weergegeven.

Help aan het begin van een functie-body

In het volgende voorbeeld ziet u opmerkingen aan het begin van een functie-body.

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

    Get-Process powershell
}

Help aan het einde van een functie-body

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

function MyFunction
{
    Get-Process powershell

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

Help vóór het sleutelwoord Functie

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

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