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

Bu konu, Get-Help cmdlet'inin yorum tabanlı yardım konusunu doğru işlevle ilişkilendirebilmesi için bir işlev için yorum tabanlı yardımın nereye yerleştirileceğini açıklamaktadır.

Bir İşlev için Yoruma Dayalı Yardımın Nereye Yerleştirileceği

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

• İşlev gövdesinin sonunda.

• İşlev anahtar sözcüğünden önce. İşlev bir komut dosyasında veya komut dosyası modülünde olduğunda, yoruma dayalı 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 komut dosyasıyla ilişkilendirir.

Bir Fonksiyona Yardım Yerleştirme Örnekleri

Aşağıdaki örnekler, bir işleve ilişkin yoruma dayalı yardıma yönelik üç yerleştirme seçeneğinin her birini göstermektedir.

Bir Fonksiyon Gövdesinin Başlangıcında Yardım

Aşağıdaki örnek, bir işlev gövdesinin başlangıcında yoruma dayalı olarak gösterilmektedir.

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

    Get-Process powershell
}

Fonksiyon Gövdesinin Sonunda Yardım

Aşağıdaki örnek, bir işlev gövdesinin sonunda yoruma dayalı olarak gösterilmektedir.

function MyFunction
{
    Get-Process powershell

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

İşlev Anahtar Kelimesinden Önce Yardım

Aşağıdaki örnekler, function anahtar sözcüğünden önceki satıra dayalı olarak açıklamayı gösterir.

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