Menempatkan Bantuan Berbasis Komentar dalam Skrip

Topik ini menjelaskan di mana menempatkan bantuan berbasis komentar untuk skrip sehingga cmdlet Get-Help mengaitkan topik bantuan berbasis komentar dengan skrip dan bukan dengan fungsi apa pun yang mungkin ada dalam skrip.

Tempat Menempatkan Bantuan Comment-Based untuk Skrip

• Di awal file skrip.

  Bantuan Skrip dapat didahului dalam skrip hanya dengan komentar dan baris kosong.

• Di akhir file skrip.

  Jika item pertama dalam isi skrip (setelah Bantuan) adalah deklarasi fungsi, setidaknya harus ada dua baris kosong antara akhir Bantuan skrip dan deklarasi fungsi. Jika tidak, Bantuan ditafsirkan sebagai Bantuan untuk fungsi, bukan Bantuan untuk skrip.

Contoh Penempatan Bantuan dalam Skrip

Contoh berikut menunjukkan setiap opsi penempatan untuk bantuan berbasis komentar untuk skrip.

Bantuan di Awal Skrip

Contoh berikut menunjukkan berbasis komentar di awal skrip.

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>

param [string]$ComputerName
...

Bantuan di Akhir Skrip

Contoh berikut menunjukkan berbasis komentar di akhir skrip.

...
function Ping { Test-Connection -ComputerName $ComputerName }

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>