Sintaks Bantuan Berbasis Komentar

Bagian ini menguraikan sintaks bantuan berbasis komentar.

Diagram Sintaks

Sintaks untuk Bantuan berbasis komentar adalah sebagai berikut:

# .< help keyword>
# <help content>

-atau-

<#
.< help keyword>
< help content>
#>

Deskripsi Sintaks

Bantuan berbasis komentar ditulis sebagai serangkaian komentar. Anda dapat mengetik simbol komentar (#) sebelum setiap baris komentar, atau Anda dapat menggunakan simbol <# dan #> untuk membuat blok komentar. Semua baris dalam blok komentar ditafsirkan sebagai komentar.

Setiap bagian Bantuan berbasis komentar didefinisikan oleh kata kunci dan setiap kata kunci didahului oleh titik (.). Kata kunci dapat muncul dalam urutan apa pun. Nama kata kunci tidak sensitif terhadap huruf besar atau kecil.

Blok komentar harus berisi setidaknya satu kata kunci bantuan. Beberapa kata kunci, seperti .EXAMPLE, dapat muncul berkali-kali di blok komentar yang sama. Konten Bantuan untuk setiap kata kunci dimulai pada baris setelah kata kunci dan dapat mencakup beberapa baris.

Semua baris dalam topik Bantuan berbasis komentar harus bersebelahan. Jika topik Bantuan berbasis komentar mengikuti komentar yang bukan bagian dari topik Bantuan, setidaknya harus ada satu baris kosong antara baris komentar non-Bantuan terakhir dan awal Bantuan berbasis komentar.

Misalnya, topik bantuan berbasis komentar berikut berisi kata kunci .DESCRIPTION dan nilainya, yang merupakan deskripsi fungsi atau skrip.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>