İşlevlere Yorum Tabanlı Yardım Yerleştirme

Bu konuda, Get-Help cmdlet'inin açıklama tabanlı yardım konusunu doğru işlevle ilişkilendirmesi için işlev için açıklama tabanlı yardımın nereye yerleştirileceği açıklanmaktadır.

İşlev için Comment-Based Yardımı Nereye Yerleştirileceği

• İşlev gövdesinin başında.

• İşlev gövdesinin sonunda.

• Function anahtar sözcüğünden önce. İşlev bir betik veya betik modülünde olduğunda, açıklama tabanlı yardımın son satırı ile Function anahtar sözcüğü arasında birden fazla boş satır olamaz. Aksi takdirde, Get-Help yardımı işlevle değil betikle ilişkilendirir.

İşlevde Yardım Yerleştirme Örnekleri

Aşağıdaki örneklerde, bir işlev için açıklama tabanlı yardım için üç yerleştirme seçeneğinin her biri gösterilmektedir.

İşlev Gövdesinin Başlangıcında Yardım

Aşağıdaki örnekte, işlev gövdesinin başında açıklama tabanlı gösterilir.

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

    Get-Process powershell
}

İşlev Gövdesinin Sonundaki Yardım

Aşağıdaki örnekte, bir işlev gövdesinin sonunda açıklama tabanlı gösterilir.

function MyFunction
{
    Get-Process powershell

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

İşlev Anahtar Sözcüğünden Önce Yardım

Aşağıdaki örneklerde işlev anahtar sözcüğünden önceki satıra dayalı açıklama gösterilmektedir.

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