Kata Kunci Bantuan Comment-Based

Topik ini mencantumkan dan menjelaskan kata kunci dalam bantuan berbasis komentar.

Kata kunci dalam Bantuan Comment-Based

Berikut ini adalah kata kunci Bantuan berbasis komentar yang valid. Mereka tercantum dalam urutan di mana mereka biasanya muncul dalam topik Bantuan bersama dengan penggunaan yang dimaksudkan. Kata kunci ini dapat muncul dalam urutan apa pun dalam Bantuan berbasis komentar, dan tidak peka huruf besar/kecil.

Perhatikan bahwa kata kunci .EXTERNALHELP lebih diutamakan daripada semua kata kunci bantuan berbasis komentar lainnya. Saat ada, cmdlet Get-Help tidak menampilkan bantuan berbasis komentar, bahkan ketika tidak dapat menemukan file bantuan yang cocok dengan nilai kata kunci.

.SYNOPSIS

Deskripsi singkat tentang fungsi atau skrip. Kata kunci ini hanya dapat digunakan sekali di setiap topik.

.DESCRIPTION

Deskripsi terperinci tentang fungsi atau skrip. Kata kunci ini hanya dapat digunakan sekali di setiap topik.

.PARAMETER <Parameter-Name>

Deskripsi parameter. Anda dapat menyertakan kata kunci .PARAMETER untuk setiap parameter dalam fungsi atau skrip.

Kata kunci .PARAMETER dapat muncul dalam urutan apa pun di blok komentar, tetapi urutan parameter muncul dalam pernyataan param atau deklarasi fungsi menentukan urutan di mana parameter muncul dalam topik Bantuan. Untuk mengubah urutan parameter dalam topik Bantuan, ubah urutan parameter dalam pernyataan param atau deklarasi fungsi.

Anda juga dapat menentukan deskripsi parameter dengan menempatkan komentar di pernyataan param segera sebelum nama variabel parameter. Jika Anda menggunakan komentar pernyataan param dan kata kunci .PARAMETER, deskripsi yang terkait dengan kata kunci .PARAMETER digunakan, dan komentar pernyataan param diabaikan.

.EXAMPLE

Contoh perintah yang menggunakan fungsi atau skrip, secara opsional diikuti oleh sampel output dan deskripsi. Ulangi kata kunci ini untuk setiap contoh.

.INPUTS

Jenis objek .NET yang dapat disalurkan ke fungsi atau skrip. Anda juga dapat menyertakan deskripsi objek input. Ulangi kata kunci ini untuk setiap jenis input.

.OUTPUTS

Jenis objek .NET yang dikembalikan oleh cmdlet. Anda juga dapat menyertakan deskripsi objek yang dikembalikan. Ulangi kata kunci ini untuk setiap jenis output.

.NOTES

Informasi tambahan tentang fungsi atau skrip.

.LINK

Nama topik terkait. Ulangi kata kunci ini untuk setiap topik terkait. Konten ini muncul di bagian Tautan Terkait dari topik Bantuan.

Konten kata kunci .LINK juga dapat menyertakan Pengidentifikasi Sumber Daya Uniform (URI) ke versi daring dari topik bantuan yang sama. Versi online terbuka saat Anda menggunakan parameter Online dari Get-Help. URI harus dimulai dengan http atau https.

.COMPONENT

Nama teknologi atau fitur yang digunakan fungsi atau skrip, atau yang terkait dengannya. Parameter ComponentGet-Help menggunakan nilai ini untuk memfilter hasil pencarian yang dikembalikan oleh Get-Help.

.ROLE

Nama peran pengguna untuk topik bantuan. Parameter RoleGet-Help menggunakan nilai ini untuk memfilter hasil pencarian yang dikembalikan oleh Get-Help.

.FUNCTIONALITY

Kata kunci yang menjelaskan penggunaan fungsi yang dimaksudkan. Parameter FunctionalityGet-Help menggunakan nilai ini untuk memfilter hasil pencarian yang dikembalikan oleh Get-Help.

.FORWARDHELPTARGETNAME <Command-Name>

Mengalihkan ke topik bantuan untuk perintah yang ditentukan. Anda dapat mengalihkan pengguna ke topik bantuan apa pun, termasuk konten bantuan untuk fungsi, skrip, cmdlet, atau penyedia.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

Menentukan jenis bantuan dari item di .FORWARDHELPTARGETNAME. Nilai yang valid adalah Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filter, atau All. Gunakan kata kunci ini untuk menghindari konflik ketika ada perintah dengan nama yang sama.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

Menentukan sesi yang berisi topik bantuan. Masukkan variabel yang berisi objek PSSession. Kata kunci ini digunakan oleh cmdlet [Export-PSSession][09] untuk menemukan konten bantuan untuk perintah yang diekspor.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Menentukan file bantuan berbasis XML untuk skrip atau fungsi.

# .EXTERNALHELP <XML Help File>

Kata kunci .EXTERNALHELP diperlukan saat fungsi atau skrip didokumenkan dalam file XML. Tanpa kata kunci ini, Get-Help tidak dapat menemukan file bantuan berbasis XML untuk fungsi atau skrip.

Kata kunci .EXTERNALHELP lebih diutamakan daripada kata kunci bantuan berbasis komentar lainnya. Jika .EXTERNALHELP ada, Get-Help tidak menampilkan bantuan berbasis komentar, meskipun tidak dapat menemukan topik bantuan yang cocok dengan nilai kata kunci .EXTERNALHELP.

Jika fungsi diekspor oleh modul, atur nilai kata kunci .EXTERNALHELP ke nama file tanpa jalur. Get-Help mencari nama file yang ditentukan dalam subdirektori khusus bahasa direktori modul. Tidak ada persyaratan untuk nama file bantuan berbasis XML untuk fungsi, tetapi praktik terbaiknya adalah menggunakan format berikut:

<ScriptModule.psm1>-help.xml

Jika fungsi tidak disertakan dalam modul, sertakan jalur ke file bantuan berbasis XML. Jika nilai menyertakan jalur dan jalur tersebut berisi subdirektori khusus budaya antarmuka pengguna, Get-Help akan mencari subdirektori secara rekursif untuk menemukan file XML dengan nama skrip atau fungsi sesuai dengan standar fallback bahasa yang ditetapkan untuk Windows, sama seperti yang dilakukan dalam direktori modul.

Untuk informasi selengkapnya tentang format file bantuan cmdlet berbasis XML, lihat Cara Menulis Bantuan Cmdlet.