Menempatkan Bantuan Berbasis Komentar di Fungsi

Topik ini menjelaskan di mana menempatkan bantuan berbasis komentar untuk fungsi sehingga cmdlet Get-Help mengaitkan topik bantuan berbasis komentar dengan fungsi yang benar.

Tempat Menempatkan Bantuan Comment-Based untuk Fungsi

• Di awal isi fungsi.

• Di akhir isi fungsi.

• Sebelum kata kunci Function. Saat fungsi berada dalam modul skrip atau skrip, tidak boleh ada lebih dari satu baris kosong antara baris terakhir bantuan berbasis komentar dan kata kunci Function. Jika tidak, Get-Help mengaitkan bantuan dengan skrip, bukan dengan fungsi .

Contoh Penempatan Bantuan dalam Fungsi

Contoh berikut menunjukkan masing-masing dari tiga opsi penempatan untuk bantuan berbasis komentar untuk fungsi.

Bantuan di Awal Isi Fungsi

Contoh berikut menunjukkan berbasis komentar di awal isi fungsi.

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

    Get-Process powershell
}

Bantuan di Akhir Isi Fungsi

Contoh berikut menunjukkan berbasis komentar di akhir isi fungsi.

function MyFunction
{
    Get-Process powershell

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

Bantuan Sebelum Kata Kunci Fungsi

Contoh berikut menunjukkan berbasis komentar pada baris sebelum kata kunci fungsi.

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