共用方式為


以批注為基礎的說明語法

本節描述以批注為基礎的說明語法。

語法圖表

批注型說明的語法如下:

# .< help keyword>
# <help content>

-或-

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

語法描述

以批注為基礎的說明會撰寫成一系列批注。 您可以在每行批註之前輸入批注符號(#),也可以使用 <##> 符號來建立批注區塊。 批注區塊中的所有行都會解譯為批註。

以批注為基礎的說明的每個區段都是由關鍵詞定義,而每個關鍵詞前面都有一個點(.)。 關鍵詞可以依任何順序顯示。 關鍵詞名稱不區分大小寫。

批注區塊必須至少包含一個 help 關鍵詞。 某些關鍵詞,例如 .EXAMPLE,可能會出現在相同的批注區塊中多次。 每個關鍵詞的說明內容都會在 關鍵詞之後的行開始,而且可以跨越多行。

批註型說明主題中的所有行都必須是連續的。 如果批注型說明主題遵循不屬於說明主題的批注,則最後一個非說明批注行與批注型說明開頭之間必須至少有一個空白行。

例如,下列以批注為基礎的說明主題包含 .DESCRIPTION 關鍵詞及其值,這是函式或腳本的描述。

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