Lägga till kommentarsbaserad hjälp i funktioner

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

Where to Place Comment-Based Help for a Function

• I början av funktionstexten.

• I slutet av funktionstexten.

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

Exempel på hjälpplacering i en funktion

I följande exempel visas vart och ett 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 funktionsnyckelordet

I följande exempel visas kommentarsbaserad på raden före funktionsnyckelordet.

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