Get-Help

Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-路徑 <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-路徑 <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Examples] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-路徑 <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-路徑 <string>] [-Role <string[]>] [<CommonParameters>]

C:\PS>get-help

描述
-----------
這個命令會顯示 Windows PowerShell 說明系統的相關說明。

C:\PS>get-help *

描述
-----------
這個命令會顯示在 Windows PowerShell 說明系統中之所有說明檔案的清單。

C:\PS>get-help get-alias

C:\PS>help get-alias

C:\PS>get-alias -?

描述
-----------
這些命令會顯示 get-alias Cmdlet 的基本資訊。"Get-Help" 和 "-?" 命令會將資訊顯示在單一頁面中。"Help" 命令會一次顯示一頁資訊。

C:\PS>get-help about_*

描述
-----------
這個命令會顯示包括在 Windows PowerShell 說明中之概念主題的清單。這些主題的開頭都會是 "about_" 字元。若要顯示特定的說明檔案，請輸入 "get-help <主題名稱>"，例如 "get-help about_signing"。

C:\PS>get-help ls -detailed

描述
-----------
這個命令會指定 Get-ChildItem Cmdlet 的其中一個別名 ("ls")，藉以顯示其詳細說明。Detailed 參數會要求此說明檔案的詳細檢視，其中會包含參數描述和範例。若要查看 Cmdlet 的完整說明檔案，請使用 Full 參數。

C:\PS>get-help format-string -full

描述
-----------
這個命令會顯示 Format-String cmdlet 說明的完整檢視。說明的完整檢視包括了參數描述、範例，以及內含這些參數之相關技術性詳細資料的表格。

C:\PS>get-help start-service -examples

描述
-----------
這個命令會顯示在 Windows PowerShell 命令中使用 start-service 的範例。

C:\PS>get-help get-childitem -parameter f*

描述
-----------
這個命令會顯示開頭為 "f" 之 Get-ChildItem Cmdlet 參數 (filter 和 force) 的描述。如需所有參數的描述，請輸入 "get-help get-childitem parameter*"。

C:\PS>(get-help write-output).syntax

描述
-----------
這個命令只會顯示 Write-Output Cmdlet 的語法。

語法是說明物件的多種屬性其中之一；其他屬性還包括描述、詳細資料、範例和參數。若要找出說明物件的所有屬性和方法，請輸入 "get-help <Cmdlet 名稱> | get-member"，例如 "get-help start-service | get member"。

C:\PS>(get-help trace-command).alertset

描述
-----------
這個命令只會顯示 Cmdlet 的附註。這些附註是儲存在說明物件的 alertSet 屬性中。

附註包含概念資訊和 Cmdlet 的使用提示。根據預設，只有在使用 Get-Help 的 Full 參數時才會顯示附註，但是也可以透過使用 alertSet 屬性顯示附註。

C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml

描述
-----------
在這個範例中，會示範如何搜尋特定 Cmdlet 說明主題中的文字。這個命令會在 Add-Member Cmdlet 的完整說明主題版本中搜尋 "clixml" 一字。

因為 Get-Help Cmdlet 會產生 MamlCommandHelpInfo 物件而不是字串，所以您需要使用可將說明主題內容轉換為字串的命令，例如 Out-String 或 Out-File。

C:\PS>get-help get-member -online

描述
-----------
這個命令會顯示 Get-Member Cmdlet 說明主題的線上版本。

C:\PS>get-help remoting

描述
-----------
這個命令會顯示其內容包含 "remoting" 一字的主題清單。

如果您輸入的文字未出現在任一說明主題標題中，則 Get-Help 會列出包含該特定文字的主題。

C:\PS>get-help get-item -path SQLSERVER:\DataCollection

NAME
    Get-Item

SYNOPSIS
    Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection.       
...

C:\PS> cd SQLSERVER:\DataCollection
C:\PS> SQLSERVER:\DataCollection> get-help get-item


NAME
    Get-Item

SYNOPSIS
    Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection.       
...


C:\PS> Get-Item

NAME
    Get-Item

SYNOPSIS
    Gets the item at the specified location.

...

描述
-----------
在這個範例中，會示範如何取得 Get-Item Cmdlet 的說明，以描述如何在 Windows PowerShell SQL Server 提供者的 DataCollection 節點中使用 Cmdlet。

此範例示範兩種取得 Get-Item 自訂說明的方式。

第一個命令會使用 Get-Help 的 Path 參數指定提供者路徑。這個命令可於任何路徑位置輸入。

第二個命令會使用 Set-Location Cmdlet (別名為 "cd") 移至提供者路徑。即使不指定 Path 參數，Get-Help 命令從該位置也能取得提供者路徑的自訂說明。

第三個命令示範檔案系統路徑中的 Get-Help 命令 (不指定 Path 路徑) 取得 Get-Item Cmdlet 的標準說明。

C:\PS>get-help c:\ps-test\MyScript.ps1

描述
-----------
這個命令會取得 MyScript.ps1 指令碼的說明。如需針對函數和指令碼撰寫說明的詳細資訊，請參閱 about_Comment_Based_Help。