Get-Help

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

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-name> | 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。