Megjegyzésalapú súgótémakörök elhelyezése függvényekben

Ez a témakör azt ismerteti, hogy hol helyezhet el megjegyzésalapú súgót egy függvényhez, hogy a Get-Help parancsmag a megjegyzésalapú súgótémakört a megfelelő függvénnyel társítsa.

Hely Comment-Based súgó egy függvényhez

• A függvény törzsének elején.

• A függvény törzsének végén.

• A Function kulcsszó előtt. Ha a függvény szkriptben vagy szkriptmodulban található, a megjegyzésalapú súgó utolsó sora és a Function kulcsszó között nem lehet több üres sor. Ellenkező esetben Get-Help a súgót nem a függvényhez, hanem a szkripthez társítja.

Példák súgóelhelyezésre egy függvényben

Az alábbi példák a függvény megjegyzésalapú súgójának három elhelyezési lehetőségét mutatják be.

Súgó a függvény törzsének elején

Az alábbi példában egy függvénytörzs elején található megjegyzésalapú szöveg látható.

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

    Get-Process powershell
}

Súgó egy függvénytörzs végén

Az alábbi példában egy függvénytörzs végén található megjegyzésalapú szöveg látható.

function MyFunction
{
    Get-Process powershell

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

Súgó a függvény kulcsszója előtt

Az alábbi példák a függvény kulcsszó előtti sor alapján jelenítik meg a megjegyzést.

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