Windows PowerShell 包含詳細的說明主題,可說明 Windows PowerShell 的概念以及 Windows PowerShell 語言。其中也包含每個 Cmdlet 和提供者的說明主題,以及許多函數和指令碼的說明主題。

您可以將說明主題顯示於命令提示字元,或在 Microsoft TechNet Library 中檢視這些主題最新的更新版本。許多主控 Windows PowerShell 的程式 (例如 Windows PowerShell 整合式指令碼環境) 都提供額外的說明功能,例如即時線上說明和編譯說明檔 (.chm)。

取得 Cmdlet 的說明

若要取得 Windows PowerShell Cmdlet 的相關說明,請使用 Get-Help Cmdlet。例如,若要取得 Get-ChildItem Cmdlet 的說明,請輸入:

get-help get-childitem

get-childitem -?

您甚至也可取得 Get-Help Cmdlet 的相關說明。例如:

get-help get-help

若要取得工作階段中所有 Cmdlet 的說明主題清單,請輸入:

get-help -category cmdlet

若要一次顯示一頁說明主題,請使用 help 函數或其別名 man。例如,若要顯示 Get-ChildItem Cmdlet 的說明,請輸入

man get-childitem

help get-childitem

若要顯示 Cmdlet、函數或指令碼的詳細資訊 (包括參數的說明及使用方式的範例),請使用 Get-Help Cmdlet 的 Detailed 參數。例如,若要取得 Get-ChildItem Cmdlet 的詳細說明,請輸入:

get-help get-childitem -detailed

若要顯示說明主題的所有內容,請使用 Get-Help Cmdlet 的 Full 參數。例如,若要顯示 Get-ChildItem Cmdlet 說明主題中的所有內容,請輸入:

get-help get-childitem -full

若要取得 Cmdlet 參數的詳細說明,請使用 Get-Help Cmdlet 的 Parameter 參數。例如,若要取得 Get-ChildItem Cmdlet 所有參數的詳細說明,請輸入:

get-help get-childitem -parameter *

若只要顯示說明主題中的範例,請使用 Get-Help 的 Example 參數。例如,若只要顯示 Get-ChildItem Cmdlet 說明主題中的範例,請輸入:

get-help get-childitem -examples

如需如何為您撰寫的 Cmdlet 撰寫說明主題的詳細資訊,請參閱 MSDN 中的<如何撰寫 Cmdlet 說明>主題。

取得概念性說明

Get-Help Cmdlet 也可以顯示 Windows PowerShell 概念性主題的相關資訊,包括有關 Windows PowerShell 語言的說明主題。概念性說明主題以 "about_" 字首開頭,例如 about_line_editing (概念性主題的名稱必須以英文輸入,甚至對於非英文版的 Windows PowerShell 也一樣)。

若要顯示概念主題的清單,請輸入:

get-help about_*

若要顯示特定說明主題,請輸入主題名稱,例如:

get-help about_command_syntax

Get-Help 的參數 (例如 DetailedParameterExamples 等) 對概念性說明主題的顯示沒有影響。

取得提供者的相關說明

Get-Help Cmdlet 會顯示 Windows PowerShell 提供者的相關資訊。若要取得提供者的說明,請輸入 "Get-Help",後面接著提供者名稱。例如,若要取得登錄提供者的說明,請輸入:

get-help registry

若要取得工作階段中所有提供者的說明主題清單,請輸入:

get-help -category provider

Get-Help 的參數 (例如 DetailedParameterExamples 等) 對提供者說明主題的顯示沒有影響。

取得指令碼和函數的相關說明

Windows PowerShell 中的許多指令碼和函數都擁有說明主題。請使用 Get-Help Cmdlet 來顯示指令碼和函數的說明主題。

若要顯示函數的說明,請輸入 "get-help",後面接著函數名稱。例如,若要取得 Disable-PSRemoting 函數的說明,請輸入:

get-help disable-psremoting

若要顯示指令碼的說明,請輸入指令檔的完整路徑。如果指令碼所在路徑列在 Path 環境變數中,您就可以從命令中省略路徑。

例如,如果您在 C:\PS-Test 目錄中有名為 "TestScript.ps1" 的指令碼,請輸入下列命令來顯示該指令碼的說明主題:

get-help c:\ps-test\TestScript.ps1

針對顯示 Cmdlet 說明而設計的參數 (例如 Detailed FullExamplesParameter),也都可以用於指令碼及函數的說明。不過,如果您是藉由輸入 "get-help *" 來顯示所有的說明,則函數和指令碼的說明並不會顯示。

如需撰寫函數和指令碼說明主題的詳細資訊,請參閱 about_Functionsabout_Scriptsabout_Comment_Based_Help

取得線上說明

如果您已連接至網際網路,取得說明的最佳方法之一就是檢視線上的說明主題。因為線上說明易於更新,所以更可能提供最新的內容。

若要取得線上說明,請使用 Get-Help Cmdlet 的 Online 參數。Get-Help Cmdlet 的 Online 參數只能用來取得 Cmdlet 說明、函數說明和指令碼說明。Online 參數不能用來取得概念性 (About) 主題或提供者說明主題。此外,因為這項功能為選擇性,所以並不適用於所有的 Cmdlet、函數或指令碼說明主題。

不過,Windows PowerShell 所隨附的所有說明主題,包括提供者說明和概念性 (About) 說明主題,都可從線上 Microsoft TechNet Library 的 Windows PowerShell 一節中取得。

請利用下列的命令格式來使用 Get-Help Cmdlet 的 Online 參數。

get-help <command-name> -online

例如,若要取得線上版本的 Get-ChildItem Cmdlet 說明主題,請輸入:

get-help get-childitem -online

如果有線上版本的說明主題可供使用,就會在預設的瀏覽器中開啟。

如果某說明主題支援線上說明版本,則您也可以檢視該說明主題的網際網路位址 (URL)。網際網路位置會出現在說明主題的「相關連結」一節中。

例如,若要查看 Add-Computer Cmdlet 線上版本的 URL,請輸入:

get-help add-computer

以下顯示說明主題「相關連結」一節的第一行。

Online version: https://go.microsoft.com/fwlink/?LinkID=135194

如需如何提供說明主題線上支援的詳細資訊,請參閱 about_Comment_Based_Help,並查看 MSDN (Microsoft Developer Network) 文件庫中的<如何撰寫 Cmdlet 說明>(英文),網址為 https://go.microsoft.com/fwlink/?LinkID=123415

請參閱




目錄