Ablegen der kommentarbasierten Hilfe in Funktionen

In diesem Thema wird erläutert, wo kommentarbasierte Hilfe für eine Funktion platziert werden soll, damit das cmdlet Get-Help das kommentarbasierte Hilfethema der richtigen Funktion zuordnet.

Wo Comment-Based Hilfe für eine Funktion platziert werden

• Am Anfang des Body der Funktion.

• Am Ende des Body der Funktion.

• Vor dem Schlüsselwort Function. Wenn sich die Funktion in einem Skript- oder Skriptmodul befindet, kann zwischen der letzten Zeile der kommentarbasierten Hilfe und dem schlüsselwort Function nicht mehr als eine leere Zeile vorhanden sein. Andernfalls ordnet Get-Help die Hilfe dem Skript zu, nicht der Funktion.

Beispiele für die Platzierung von Hilfen in einer Funktion

Die folgenden Beispiele zeigen jede der drei Platzierungsoptionen für die kommentarbasierte Hilfe für eine Funktion.

Hilfe am Anfang eines Funktionstexts

Das folgende Beispiel zeigt kommentarbasiert am Anfang eines Funktionstexts.

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

    Get-Process powershell
}

Hilfe am Ende eines Funktionstexts

Das folgende Beispiel zeigt kommentarbasiert am Ende eines Funktionstexts.

function MyFunction
{
    Get-Process powershell

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

Hilfe vor dem Funktionsschlüsselwort

Die folgenden Beispiele zeigen kommentarbasiert auf der Zeile vor dem Funktionsschlüsselwort.

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