本主題列出並描述批注型說明中的關鍵詞。
說明中的關鍵詞 Comment-Based
以下是以批注為基礎的有效說明關鍵詞。 它們會依其通常出現在 [說明] 主題中以及其預定用途的順序列出。 這些關鍵詞可以依批注型說明的任何順序顯示，而且不會區分大小寫。
請注意，.EXTERNALHELP 關鍵詞優先於所有其他以批注為基礎的說明關鍵詞。
當 .EXTERNALHELP 存在時，Get-Help Cmdlet 不會顯示批注型說明，即使找不到符合 關鍵詞值的說明檔也一般。
.SYNOPSIS
函式或腳本的簡短描述。 每個主題中只能使用此關鍵詞一次。
.DESCRIPTION
函式或腳本的詳細描述。 每個主題中只能使用此關鍵詞一次。
.PARAMETER <Parameter-Name>
參數的描述。 您可以在函式或文稿中包含每個參數的 .PARAMETER 關鍵詞。
.PARAMETER 關鍵詞可以依批注區塊中的任何順序顯示，但參數出現在 param 語句或函式宣告中的順序會決定參數出現在 [說明] 主題中的順序。 若要變更 [說明] 主題中的參數順序，請變更 param 語句或函數宣告中的參數順序。
您也可以將批註放在參數變數名稱之前的 param 語句中，以指定參數描述。 如果您使用 param 語句批注和 .PARAMETER 關鍵詞，則會使用與 .PARAMETER 關鍵詞相關聯的描述，並忽略 param 語句批注。
.EXAMPLE
使用函式或腳本的範例命令，選擇性地後面接著範例輸出和描述。 針對每個範例重複這個關鍵詞。
.INPUTS
可傳送至函式或腳本之物件的 .NET 類型。 您也可以包含輸入物件的描述。 針對每個輸入類型重複這個關鍵詞。
.OUTPUTS
Cmdlet 傳回之物件的 .NET 類型。 您也可以包含傳回物件的描述。 針對每個輸出類型重複這個關鍵詞。
.NOTES
函式或腳本的其他資訊。
.LINK
相關主題的名稱。 針對每個相關主題重複這個關鍵詞。 此內容會出現在 [說明] 主題的 [相關連結] 區段中。
.LINK 關鍵詞內容也可以包含相同幫助主題的在線版本統一資源標識碼（URI）。 當您使用 的 Get-Help 參數時，會開啟在線版本。 URI 的開頭 http 必須是 或 https。
.COMPONENT
函式或腳本所使用的技術或功能名稱，或其相關。
Component 的 Get-Help 參數會使用此值來篩選 Get-Help所傳回的搜尋結果。
.ROLE
說明主題的使用者角色名稱。
Role 的 Get-Help 參數會使用此值來篩選 Get-Help所傳回的搜尋結果。
.FUNCTIONALITY
描述函式用途的關鍵詞。
Functionality 的 Get-Help 參數會使用此值來篩選 Get-Help所傳回的搜尋結果。
.FORWARDHELPTARGETNAME <Command-Name>
跳轉到指定命令的說明主題。 您可以將使用者重新導向至任何說明主題，包括函式、腳本、Cmdlet 或提供者的說明內容。
# .FORWARDHELPTARGETNAME <Command-Name>
.FORWARDHELPCATEGORY
指定 .FORWARDHELPTARGETNAME中項目的說明類別。 有效值為 Alias、Cmdlet、HelpFile、Function、Provider、General、FAQ、Glossary、ScriptCommand、ExternalScript、Filter或 All。 使用這個關鍵詞，以避免有具有相同名稱的命令時發生衝突。
# .FORWARDHELPCATEGORY <Category>
.REMOTEHELPRUNSPACE <PSSession-variable>
指定一個包含說明主題的工作階段。 輸入變數，其中包含 PSSession 物件。 [Export-PSSession][09] Cmdlet 會使用此關鍵詞來尋找導出命令的說明內容。
# .REMOTEHELPRUNSPACE <PSSession-variable>
.EXTERNALHELP
指定用於文稿或函式的 XML 格式說明文件。
# .EXTERNALHELP <XML Help File>
當函式或腳本記載在 XML 檔案中時，需要 .EXTERNALHELP 關鍵詞。
如果沒有這個關鍵詞，Get-Help 找不到函式或腳本的 XML 型說明檔。
.EXTERNALHELP 關鍵詞優先於其他以批注為基礎的說明關鍵詞。 如果 .EXTERNALHELP 存在，Get-Help 就不會顯示以批注為基礎的說明，即使找不到符合 .EXTERNALHELP 關鍵詞值的說明主題也一樣。
如果函式是由模組匯出，請將 .EXTERNALHELP 關鍵詞的值設定為沒有路徑的檔名。
Get-Help 在模組目錄的語言特定子目錄中尋找指定的檔名。 函數的 XML 型說明檔名稱沒有需求。 從 PowerShell 5.0 開始，模組匯出的函式可以記錄在以模組命名的說明檔案中。 您不需要使用 .EXTERNALHELP 註解關鍵字。 例如，如果函式是由模組匯MyModule出的，您可以Test-Function將說明檔案MyModule-help.xml命名為 。 Cmdlet 會在Get-Help模組目錄的檔案中MyModule-help.xml尋找函式的Test-Function說明。
如果函式未包含在模組中，請包含 XML 型說明檔的路徑。 如果值包含路徑，且路徑包含UI文化特性特定的子目錄，Get-Help 會根據針對Windows建立的語言後援標準，以遞歸方式搜尋具有腳本或函式名稱的 XML 檔案，就像在模組目錄中一樣。
如需 Cmdlet 說明 XML 說明檔案格式的詳細資訊，請參閱 如何撰寫 Cmdlet 說明。
