Get-Help
显示有关 Windows PowerShell 命令和概念的信息。
语法
Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-示例] [[-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>]
说明
Get-Help cmdlet 显示有关 Windows PowerShell 概念和命令（包括 cmdlet、提供程序、函数和脚本）的信息。要获取所有 cmdlet 帮助主题标题的列表，请键入“get-help *”。
如果键入“Get-Help”并在其后键入帮助主题的确切名称或某个帮助主题特有的字，Get-Help 会显示该主题的内容。如果您输入了出现在若干个帮助主题标题中的字或字图，Get-Help 将显示匹配标题的列表。如果输入的字未出现在任何帮助主题标题中，Get-Help 将显示内容中包括该字的主题的列表。
除“get-help”外，还可以键入“help”或“man”（一次显示一屏文本），或者键入“<cmdlet-name> -?”（与 Get-Help 相同，但只适用于 cmdlet）。
可以显示完整的帮助文件，或其中的选定部分，如语法、参数或示例。还可使用 Online 参数在 Internet 浏览器中显示帮助文件的联机版本。这些参数对概念性帮助主题没有影响。
Windows PowerShell 中的概念性帮助主题以“about_”开头，如“about_Comparison_Operators”。要查看所有“about_”主题，请键入“get-help about_*”。要查看特定主题，请键入“get-help about_<主题名>”，如“get-help about_Comparison_Operators”。
参数
-Category <string[]>
显示指定类别中项的帮助。有效值为 Alias、Cmdlet、Provider 和 HelpFile。概念性主题在 HelpFile 类别中。
Category 是 Get-Help 返回的 MamlCommandHelpInfo 对象的一个属性。此参数不影响概念性（“about_”）帮助的显示。
是否为必需？ |
false |
位置？ |
named |
默认值 |
|
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-Component <string[]>
显示具有指定的组件值（例如“Exchange”）的工具的列表。输入组件名。允许使用通配符。
Component 是 Get-Help 返回的 MamlCommandHelpInfo 对象的一个属性。此参数不影响概念性（“About_”）帮助的显示。
是否为必需？ |
false |
位置？ |
named |
默认值 |
|
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-Detailed
将参数说明以及示例添加到基本的帮助显示中。
此参数不影响概念性（“About_”）帮助的显示。
是否为必需？ |
false |
位置？ |
named |
默认值 |
|
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-示例
只显示名称、摘要和示例。要只显示示例，请键入“(get-help <cmdlet-name>).examples”。
此参数不影响概念性（“About_”）帮助的显示。
是否为必需？ |
false |
位置？ |
named |
默认值 |
|
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-Full
显示一个 cmdlet 的完整帮助文件，其中包括参数说明和属性、示例、输入和输出对象类型以及附加注释。
此参数不影响概念性（“About_”）帮助的显示。
是否为必需？ |
false |
位置？ |
named |
默认值 |
|
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-Functionality <string[]>
显示具有指定功能的项的帮助。输入功能。允许使用通配符。
Functionality 是 Get-Help 返回的 MamlCommandHelpInfo 对象的一个属性。此参数不影响概念性（“About_”）帮助的显示。
是否为必需？ |
false |
位置？ |
named |
默认值 |
|
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-Name <string>
请求有关指定的工具或概念性主题的帮助。输入 cmdlet、提供程序、脚本或函数名称（如 Get-Member）、概念性主题名称（如“about_Objects”）或别名（如“ls”）。在 cmdlet 和提供程序名称中允许使用通配符，但不能使用通配符查找函数帮助和脚本帮助主题的名称。
若要为不在 Path 环境变量中所列出的路径中的脚本获取帮助，请键入该脚本的路径和文件名。
如果您输入的正好是帮助主题的名称，Get-Help 将显示主题内容。如果您输入了出现在若干个帮助主题标题中的字或字图，Get-Help 将显示匹配标题的列表。如果您输入的字不匹配任何帮助主题标题，Get-Help 将显示内容包括该字的主题的列表。
概念主题的名称（如 about_Objects）必须用英文输入，即使在非英文版的 Windows PowerShell 中也是如此。
是否为必需？ |
false |
位置？ |
1 |
默认值 |
|
是否接受管道输入？ |
true (ByPropertyName) |
是否接受通配符？ |
false |
-Online
在默认的 Internet 浏览器中显示帮助主题的联机版本。此参数仅适用于 cmdlet、函数和脚本帮助主题。
Get-Help 使用显示在 cmdlet、函数或脚本帮助主题的“相关链接”部分的第一个项中的 Internet 地址（统一资源标识符 [URI]）。仅当帮助主题包含以“Http”或“Https”开头的 URI 并且系统上已安装 Internet 浏览器时，此参数才适用。
有关在您编写的帮助主题中支持该功能的信息，请参阅 about_Comment_Based_Help，另请参阅 MSDN (Microsoft Developer Network) Library 中的“如何编写 Cmdlet 帮助”，网址是 https://go.microsoft.com/fwlink/?LinkID=123415。
是否为必需？ |
false |
位置？ |
named |
默认值 |
无 |
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-Parameter <string>
只显示指定参数的详细说明。允许使用通配符。
此参数不影响概念性（“About_”）帮助的显示。
是否为必需？ |
false |
位置？ |
named |
默认值 |
|
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-路径 <string>
获取说明 cmdlet 如何在指定的提供程序路径中工作的帮助。输入 Windows PowerShell 提供程序路径。
此参数获取 cmdlet 帮助主题的自定义版本，该帮助主题说明 cmdlet 如何在指定的 Windows PowerShell 提供程序路径中工作。此参数仅对于有关提供程序 cmdlet 的帮助有效，并且仅当该提供程序包括自定义版本的提供程序 cmdlet 帮助主题时才有效。
要查看提供程序路径的自定义 cmdlet 帮助，请转到提供程序路径位置并输入 Get-Help 命令，或者从任意路径位置使用 Get-Help 的 Path 参数来指定提供程序路径。有关详细信息，请参阅 about_Providers。
是否为必需？ |
false |
位置？ |
named |
默认值 |
|
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
-Role <string[]>
显示为指定的用户角色自定义的帮助。输入一个角色。允许使用通配符。
输入用户在组织中担任的职位。某些 cmdlet 可以根据此参数的值在其帮助文件中显示不同的文本。此参数不影响核心 cmdlet 的帮助。
是否为必需？ |
false |
位置？ |
named |
默认值 |
|
是否接受管道输入？ |
false |
是否接受通配符？ |
false |
<CommonParameters>
此 cmdlet 支持通用参数：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息，请参阅 about_Commonparameters.
输入和输出
输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。
输入 |
无 不能通过管道将对象传递给此 cmdlet。 |
输出 |
System.String 或 MamlCommandHelpInfo 如果请求某一概念性主题，Get-Help 将以字符串的形式返回该主题。如果指定 cmdlet、函数或脚本的名称，则该命令返回 MamlCommandHelpInfo 对象。否则 Get-Help 返回 $pshome 目录的 Help.Format.ps1xml 文件中所指定的某一格式化视图。 |
说明
在没有参数的情况下，“Get-Help”显示有关 Windows PowerShell 帮助系统的信息。
help 的完整视图 (-full) 包括有关参数的信息的表。该表包括下列字段：
-- 必需：指示参数是必需的 (true) 还是可选的 (false)。
-- 位置：指示参数是命名参数还是位置参数（编号参数）。位置参数必须出现在命令中的指定位置。
--“命名”表示参数名称是必需的，但参数可以出现在命令中的任何地方。
-- <数字> 表示参数名称是可选的，但是当省略名称时，参数必须位于数字指定的位置。例如，“2”表示当省略参数名称时，参数必须是命令中的第二个 (2) 或唯一的未命名参数。当使用参数名称时，参数可以出现在命令中的任何地方。
-- 默认值：在命令中没有使用参数的情况下 Windows PowerShell 所使用的参数值。
-- 是否接受管道输入：指示您可以 (true) 还是不可以 (false) 通过管道向参数发送对象。“按属性名称”表示通过管道传递的对象必须具有其名称与参数名称相同的属性。
-- 是否接受通配符：指示参数的值是否可以包括诸如 * 和 ? 之类的通配符。
示例 1
C:\PS>get-help
说明
-----------
此命令显示有关 Windows PowerShell 帮助系统的帮助。
示例 2
C:\PS>get-help *
说明
-----------
此命令显示 Windows PowerShell 帮助系统中的所有帮助文件的列表。
示例 3
C:\PS>get-help get-alias
C:\PS>help get-alias
C:\PS>get-alias -?
说明
-----------
这些命令显示有关 get-alias cmdlet 的基本信息。“Get-Help”和“-?”命令在单个页面上显示信息。“Help”命令一次一个页面地显示信息。
示例 4
C:\PS>get-help about_*
说明
-----------
此命令显示 Windows PowerShell 帮助中包括的概念主题的列表。所有这些主题都以字符“about_”开始。若要显示特定帮助文件，请键入“get-help <主题名称>”，例如，“get-help about_signing”。
示例 5
C:\PS>get-help ls -detailed
说明
-----------
此命令通过指定 Get-ChildItem cmdlet 的一个别名“ls”来显示其详细帮助。Detailed 参数请求帮助文件的详细视图，包括参数描述和示例。若要查看 cmdlet 的完整的帮助文件，请使用 Full 参数。
示例 6
C:\PS>get-help format-string -full
说明
-----------
此命令显示 Format-String cmdlet 的完整视图帮助。帮助的完整视图包括参数说明、示例，以及有关参数的详细技术信息的表。
示例 7
C:\PS>get-help start-service -examples
说明
-----------
此命令显示在 Windows PowerShell 命令中使用 start-service 的示例。
示例 8
C:\PS>get-help get-childitem -parameter f*
说明
-----------
此命令显示以“f”开始的 Get-ChildItem cmdlet 的参数（filter 和 force）的说明。有关所有参数的说明，请键入“get-help get-childitem parameter*”。
示例 9
C:\PS>(get-help write-output).syntax
说明
-----------
此命令只显示 Write-Output cmdlet 的语法。
语法是帮助对象的许多属性之一；其他是描述、详细信息、示例和参数。若要查找帮助对象的所有属性和方法，请键入“get-help <cmdlet-name> | get-member”；例如，“get-help start-service | get member”。
示例 10
C:\PS>(get-help trace-command).alertset
说明
-----------
此命令显示该 cmdlet 的相关注释。注释存储在帮助对象的 alertSet 属性中。
注释包括概念性信息和使用 cmdlet 的提示。默认情况下，只有使用 Get-Help 的 Full 参数时才会显示注释，但也可使用 alertSet 属性显示它们。
示例 11
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。
示例 12
C:\PS>get-help get-member -online
说明
-----------
此命令显示 Get-Member cmdlet 的联机版帮助主题。
示例 13
C:\PS>get-help remoting
说明
-----------
此命令显示内容中包含单词“remoting”一字的主题的列表。
如果输入的字未出现在任何主题标题中，Get-Help 将显示包括该字的主题列表。
示例 14
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 的标准帮助。
示例 15
C:\PS>get-help c:\ps-test\MyScript.ps1
说明
-----------
此命令获取 MyScript.ps1 脚本的帮助。有关如何编写函数和脚本的帮助的信息，请参阅 about_Comment_Based_Help。