Get-Help

參考

模組:: Microsoft.PowerShell.Core

顯示 PowerShell 命令和概念的相關信息。

Syntax

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Description

Cmdlet Get-Help 會顯示 PowerShell 概念和命令的相關信息，包括 Cmdlet、函式、Common Information Model (CIM) 命令、工作流程、提供者、別名和腳本。

若要取得 PowerShell Cmdlet 的說明，請輸入 Get-Help 後面接著 Cmdlet 名稱，例如： Get-Help Get-Process。

PowerShell 中的概念說明文章從 about_開始，例如 about_Comparison_Operators。若要檢視所有 about_ 文章，請輸入 Get-Help about_*。若要檢視特定文章，請輸入 Get-Help about_<article-name>，例如 Get-Help about_Comparison_Operators。

若要取得 PowerShell 提供者的說明，請輸入 Get-Help ，後面接著提供者名稱。例如，若要取得憑證提供者的說明，請輸入 Get-Help Certificate。

您也可以輸入 help 或 man，一次顯示一個文字畫面。或者， <cmdlet-name> -?與相同 Get-Help，但僅適用於 Cmdlet。

Get-Help 會從電腦上的說明檔取得其顯示的說明內容。如果沒有說明檔， Get-Help 則只會顯示 Cmdlet 的基本資訊。某些 PowerShell 模組包含說明檔。從 PowerShell 3.0 開始，Windows 作業系統隨附的模組不包含說明檔。若要在PowerShell 3.0 中下載或更新模組的說明檔，請使用 Update-Help Cmdlet。

您也可以在 Microsoft Docs 在線檢視 PowerShell 說明檔。若要取得說明檔的在線版本，請使用 Online 參數，例如：Get-Help Get-Process -Online。若要閱讀所有 PowerShell 檔，請參閱 Microsoft Docs PowerShell 檔。

如果您輸入 Get-Help 後面接著說明文章的確切名稱，或是說明文章唯一的字組， Get-Help 則會顯示文章的內容。如果您指定命令別名的確切名稱， Get-Help 會顯示原始命令的說明。如果您輸入出現在數個說明文章標題中的單字或單字模式， Get-Help 會顯示相符標題的清單。如果您輸入任何未出現在任何說明文章標題中的文字， Get-Help 則會顯示包含在其內容中的文章清單。

Get-Help 可以取得所有支援語言和地區設定的說明文章。 Get-Help先尋找 Windows 地區設定中的說明檔，然後在父地區設定中尋找，例如 pt-BR 的 pt，然後在後援地區設定中尋找說明檔。從 PowerShell 3.0 開始，如果在 Get-Help 後援地區設定中找不到說明，它會在傳回錯誤訊息或顯示自動產生的說明之前，先尋找英文、 en-US 的說明文章。

如需命令語法圖表中顯示的符號 Get-Help 相關信息，請參閱 about_Command_Syntax。如需參數屬性的相關信息，例如必要和位置，請參閱 about_Parameters。

注意

在 PowerShell 3.0 和 PowerShell 4.0 中， Get-Help 除非模組已匯入目前的會話，否則在模組中找不到 About 文章。這是已知的問題。若要取得模組中的 About 文章，請使用 Import-Module Cmdlet 或執行模組中包含的 Cmdlet 來匯入模組。

範例

範例 1：顯示 Cmdlet 的基本說明資訊

這些範例會顯示 Cmdlet 的基本說明資訊 Format-Table 。

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> 是 Cmdlet 的最簡單和預設語法 Get-Help 。您可以省略 Name 參數。

<cmdlet-name> -?語法僅適用於 Cmdlet。

範例 2：一次顯示一個頁面的基本資訊

這些範例會顯示 Cmdlet 一 Format-Table 次一頁的基本說明資訊。

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help 是一個函式，會在內部執行 Get-Help Cmdlet，並一次顯示一頁的結果。

man 是函式的 help 別名。

Get-Help Format-Table 將物件傳送至管線。 Out-Host -Paging 接收管線的輸出，並一次顯示一個頁面。如需詳細資訊，請參閱 Out-Host。

範例 3：顯示 Cmdlet 的詳細資訊

這些範例會顯示更詳細的 Cmdlet 說明資訊 Format-Table 。

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

[詳細] 參數會顯示說明文章的詳細檢視，其中包含參數描述和範例。

Full 參數會顯示說明文章的完整檢視，其中包含參數描述、範例、輸入和輸出物件類型，以及其他附註。

[詳細] 和 [完整] 參數僅適用於計算機上已安裝說明檔的命令。參數不適用於概念性 (about_) 說明文章。

範例 4：使用參數顯示 Cmdlet 的選取部分

這些範例會顯示 Cmdlet 說明的 Format-Table 選取部分。

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Examples 參數會顯示說明檔的 NAME 和 SYNOPSIS 區段，以及所有範例。您無法指定 Example 編號，因為 Examples 參數是 switch 參數。

Parameter 參數只會顯示指定參數的描述。如果您只指定星號 () * 通配符，則會顯示所有參數的描述。當 Parameter 指定 GroupBy 之類的參數名稱時，會顯示該參數的相關信息。

這些參數不適用於概念 性 (about_) 說明文章。

範例 5：顯示在線版本的說明

本範例會顯示預設網頁瀏覽器中 Cmdlet 說明文章 Format-Table 的在線版本。

Get-Help Format-Table -Online

範例 6：顯示說明系統的說明

Get-Help沒有參數的 Cmdlet 會顯示 PowerShell 說明系統的相關信息。

Get-Help

範例 7：顯示可用的說明文章

此範例會顯示計算機上所有可用說明文章的清單。

Get-Help *

範例 8：顯示概念性文章的清單

此範例會顯示 PowerShell 說明中包含的概念性文章清單。所有這些文章都是以字元 about_開頭。若要顯示特定的說明檔，請輸入 Get-Help \<about_article-name\>，例如 Get-Help about_Signing。

只會顯示電腦上已安裝說明檔的概念性文章。如需在PowerShell 3.0 中下載及安裝說明檔的相關信息，請參閱 Update-Help。

Get-Help about_*

範例 9：在 Cmdlet 說明中為單字搜尋

此範例示範如何在 Cmdlet 說明文章中搜尋單字。

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help 會使用 Full 參數來取得的說明 Add-Member資訊。 MamlCommandHelpInfo 物件會在管線下傳送。 Out-String會使用 Stream 參數，將對象轉換成字串。 Select-String 會使用 Pattern 參數來搜尋 Clixml 的字串。

範例 10：顯示包含單字的文章清單

本範例會顯示包含遠端文字的文章清單。

當您輸入未出現在任何文章標題的字組時， Get-Help 會顯示包含該單字的文章清單。

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

範例 11：顯示提供者特定的說明

此範例示範取得提供者特定說明的 Get-Item兩種方式。這些命令會取得說明如何在PowerShell SQL Server提供者的DataCollection節點中使用 Get-Item Cmdlet 的說明。

第一個範例會Get-Help使用Path參數來指定 SQL Server提供者的路徑。因為指定提供者的路徑，所以您可以從任何路徑位置執行命令。

第二個範例會使用 Set-Location 巡覽至 SQL Server 提供者的路徑。從該位置，不需要 Path 參數 Get-Help ，才能取得提供者特定的說明。

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.
    ...

Set-Location SQLSERVER:\DataCollection
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.
    ...

範例 12：顯示腳本的說明

這個範例會取得的說明 MyScript.ps1 script。如需如何為您的函式和腳本撰寫說明的詳細資訊，請參閱 about_Comment_Based_Help。

Get-Help -Name C:\PS-Test\MyScript.ps1

參數

-Category

僅針對指定類別中的項目顯示說明及其別名。概念性文章位於 HelpFile 類別中。

此參數可接受的值如下所示：

Alias
Cmdlet
提供者
一般
常見問題集
詞彙
HelpFile
ScriptCommand
函式
篩選
ExternalScript
全部
DefaultHelp
工作流程
DscResource
類別
設定

Type:	String[]
Accepted values:	Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Component

顯示具有指定元件值的命令，例如 Exchange。輸入元件名稱。允許使用萬用字元。此參數不會影響概念 (About_) 說明的顯示。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Detailed

將參數說明和範例新增到基本的說明顯示中。只有在計算機上安裝說明檔時，此參數才有效。它不會影響概念 (About_) 說明的顯示。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Examples

只顯示名稱、概要和範例。若要只顯示範例，請輸入 (Get-Help \<cmdlet-name\>).Examples。

只有在計算機上安裝說明檔時，此參數才有效。它不會影響概念 (About_) 說明的顯示。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Full

顯示 Cmdlet 的整個說明文章。完整包含參數描述和屬性、範例、輸入和輸出物件類型，以及其他附註。

只有在計算機上安裝說明檔時，此參數才有效。它不會影響概念 (About_) 說明的顯示。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Functionality

顯示具有指定功能的項目說明。輸入功能。允許使用萬用字元。此參數不會影響概念 (About_) 說明的顯示。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Name

取得指定命令或概念的相關說明。輸入 Cmdlet、函式、提供者、腳稿或工作流程的名稱，例如 Get-Member、概念性發行項名稱，例如 about_Objects或別名，例如 ls。 Cmdlet 和提供者名稱允許通配符，但您無法使用通配符來尋找函式說明和腳本說明文章的名稱。

若要取得不在環境變數中 $env:Path 所列路徑之腳本的說明，請輸入腳本的路徑和檔名。

如果您輸入說明文章的確切名稱， Get-Help 會顯示文章內容。

如果您輸入出現在數個說明文章標題中的單字或單字模式， Get-Help 會顯示相符標題的清單。

如果您輸入任何不符合任何說明文章標題的文字， Get-Help 會顯示包含該文字之內容的文章清單。

概念性文章的名稱，例如 about_Objects必須以英文輸入，即使是非英文版本的PowerShell也一樣。

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-Online

在預設瀏覽器中顯示說明文章的在線版本。此參數僅適用於 Cmdlet、函式、工作流程和腳本說明文章。您無法在遠端工作階段中使用 Online 參數 Get-Help 。

如需在您所撰寫的說明文章中支援此功能的相關信息，請參閱 about_Comment_Based_Help和支援在線說明，以及撰寫 PowerShell Cmdlet 的說明。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Parameter

只顯示指定參數的詳細說明。允許使用萬用字元。此參數不會影響概念 (About_) 說明的顯示。

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-Path

取得說明 Cmdlet 如何在指定的提供者路徑中運作的說明。輸入 PowerShell 提供者路徑。

此參數會取得 Cmdlet 說明文章的自定義版本，說明 Cmdlet 如何在指定的 PowerShell 提供者路徑中運作。此參數僅適用於提供者 Cmdlet 的說明，而且只有在提供者在其說明檔中包含提供者 Cmdlet 說明文章的自定義版本時才有效。若要使用這個參數，請針對包含提供者的模組安裝說明檔。

若要查看提供者路徑的自定義 Cmdlet 說明，請移至提供者路徑位置，然後輸入Get-Help命令，或者，從任何路徑位置，使用的 Get-HelpPath 參數來指定提供者路徑。您也可以在說明文章的提供者說明一節中找到在線自定義 Cmdlet 說明。

如需 PowerShell 提供者的詳細資訊，請參閱 about_Providers。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Role

顯示針對指定使用者角色自訂的說明。輸入角色。允許使用萬用字元。

輸入使用者在組織中扮演的角色。某些 Cmdlet 會根據這個參數值，在說明檔中顯示不同的文字。這個參數不會對核心 Cmdlet 的說明產生任何影響。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ShowWindow

在視窗中顯示說明主題，以便更容易閱讀。此視窗包含 [ 尋找搜尋功能] 和 [ 設定 ] 方塊，可讓您設定顯示的選項，包括僅顯示說明主題所選取區段的選項。

ShowWindow 參數支援命令的說明主題， (Cmdlet、函式、CIM 命令、腳本) 和概念 About 文章。它不支援提供者說明。

此參數已在PowerShell 7.0中重新引進。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

None

您無法將物件向下傳送至 Get-Help管線。

輸出

ExtendedCmdletHelpInfo

如果您在沒有說明檔的命令上執行 Get-Help ， Get-Help 會傳回代表自動產生說明的 ExtendedCmdletHelpInfo 物件。

String

如果您收到概念說明文章， Get-Help 請將它當做字串傳回。

MamlCommandHelpInfo

如果您取得具有說明檔的命令， Get-Help 會傳回 MamlCommandHelpInfo 物件。

備註

PowerShell 3.0 不包含說明檔。若要下載並安裝讀取的說明檔 Get-Help ，請使用 Update-Help Cmdlet。您可以使用 Update-Help Cmdlet 來下載並安裝 PowerShell 隨附的核心命令說明檔，以及您安裝的任何模組。您也可以使用它來更新說明檔，讓電腦上的說明永遠都不會過期。

您也可以閱讀 PowerShell 在線隨附之命令的說明文章，從使用者入門 Windows PowerShell 開始。

Get-Help 會在 Windows 作業系統的地區設定或該地區設定的後援語言中顯示說明。如果您沒有主要或後援地區設定的說明檔， Get-Help 行為就像計算機上沒有說明檔案一樣。若要取得不同地區設定的說明，請使用控制台中的區域和語言來變更設定。在 Windows 10 或更高版本上，[設定]、[時間 & 語言]。

說明的完整檢視包含參數相關信息的數據表。該表格包含下列欄位：

[必要]。指出參數是否為必要 (true) 或選擇性 (false)。
位置。指出參數是具名還是位置 (數值) 。位置參數必須出現在命令中指定的位置。
Named 表示參數名稱是必要的，但參數可以出現在命令中的任何位置。
數值表示參數名稱是選擇性的，但省略名稱時，參數必須位於數位所指定的位置。例如， 2 表示省略參數名稱時，參數必須是命令中的第二個或只有未命名的參數。使用參數名稱時，參數可以出現在命令中的任何位置。
預設值。如果您未在命令中包含參數，PowerShell 所使用的參數值或預設行為。
接受管線輸入。指出您可以 (true) 或無法 (false，) 透過管線將對象傳送至參數。 依 [屬性名稱 ] 表示管線對象必須具有與參數名稱相同的屬性。
接受通配符。指出參數的值是否可以包含通配符，例如星號 () * 或問號 () ? 。

共用方式為

Get-Help

Syntax

Description

範例

範例 1：顯示 Cmdlet 的基本說明資訊

範例 2：一次顯示一個頁面的基本資訊

範例 3：顯示 Cmdlet 的詳細資訊

範例 4：使用參數顯示 Cmdlet 的選取部分

範例 5：顯示在線版本的說明

範例 6：顯示說明系統的說明

範例 7：顯示可用的說明文章

範例 8：顯示概念性文章的清單

範例 9：在 Cmdlet 說明中為單字搜尋

範例 10：顯示包含單字的文章清單

範例 11：顯示提供者特定的說明

範例 12：顯示腳本的說明

參數

-Category

-Component

-Detailed

-Examples

-Full

-Functionality

-Name

-Online

-Parameter

-Path

-Role

-ShowWindow

輸入

輸出

備註

其他資源

共用方式為

Get-Help

Syntax

Description

範例

範例 1：顯示 Cmdlet 的基本說明資訊

範例 2：一次顯示一個頁面的基本資訊

範例 3：顯示 Cmdlet 的詳細資訊

範例 4：使用參數顯示 Cmdlet 的選取部分

範例 5：顯示在線版本的說明

範例 6：顯示說明系統的說明

範例 7：顯示可用的說明文章

範例 8：顯示概念性文章的清單

範例 9：在 Cmdlet 說明中為單字 搜尋

範例 10：顯示包含單字的文章清單

範例 11：顯示提供者特定的說明

範例 12：顯示腳本的說明

參數

-Category

-Component

-Detailed

-Examples

-Full

-Functionality

-Name

-Online

-Parameter

-Path

-Role

-ShowWindow

輸入

輸出

備註

相關連結

其他資源

範例 9：在 Cmdlet 說明中為單字搜尋