Bagikan melalui


Elemen Autogenerated Bantuan Berbasis Komentar

cmdlet Get-Help secara otomatis menghasilkan beberapa elemen topik berbasis komentar. Elemen yang dibuat secara otomatis ini membuat bantuan berbasis komentar terlihat sangat mirip dengan bantuan yang dihasilkan dari file XML.

Elemen yang Dibuat Secara Otomatis

cmdlet Get-Help secara otomatis menghasilkan elemen topik bantuan berikut. Anda tidak dapat mengedit elemen-elemen ini secara langsung, tetapi Anda dapat mengubah hasilnya dengan mengubah sumber elemen.

Nama

Bagian Nama dari topik Bantuan fungsi diambil dari nama fungsi dalam definisi fungsi. Nama topik Bantuan skrip diambil dari nama file skrip. Untuk mengubah nama atau kapitalisasinya, ubah definisi fungsi atau nama file skrip.

Sintaksis

Bagian Sintaks dari topik Bantuan dihasilkan dari daftar parameter dalam pernyataan param fungsi atau skrip. Untuk menambahkan detail ke sintaks topik Bantuan, seperti jenis .NET parameter, tambahkan detail ke daftar parameter. Jika Anda tidak menentukan jenis parameter, jenis Objek disisipkan sebagai nilai default.

Daftar Parameter

Bagian Parameter dari topik Bantuan dihasilkan dari daftar parameter dalam fungsi atau skrip dan dari deskripsi yang Anda tambahkan menggunakan kata kunci atau komentar .PARAMETER dalam daftar parameter.

Parameter muncul di bagian Parameter dalam urutan yang sama dengan yang muncul di daftar parameter. Ejaan dan kapitalisasi nama parameter juga diambil dari daftar parameter; tidak terpengaruh oleh nama parameter yang ditentukan oleh kata kunci .PARAMETER.

Parameter Umum

Parameter umum ditambahkan ke sintaksis dan daftar parameter topik Bantuan, meskipun tidak berpengaruh. Untuk informasi selengkapnya tentang parameter umum, lihat about_CommonParameters.

Tabel Atribut Parameter

Get-Help menghasilkan tabel atribut parameter yang muncul saat Anda menggunakan parameter Full atau Parameter dari Get-Help. Nilai atribut Diperlukan, Posisi, dan Nilai Default diambil dari sintaks fungsi atau skrip.

Komentar

Bagian Keterangan dari topik Bantuan secara otomatis dihasilkan dari fungsi atau nama skrip. Anda tidak dapat mengubah atau memengaruhi kontennya.