Get-Help

语法

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

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

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

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

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

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

说明

Get-Help cmdlet 显示有关 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 首先在 Windows 的区域设置中查找帮助文件，然后在父区域设置（例如 pt for pt-BR），然后在回退区域设置中查找帮助文件。 从 PowerShell 3.0 开始，如果 Get-Help 在回退区域设置中找不到帮助，则会在返回错误消息或显示自动生成的帮助之前查找英语帮助文章 en-US。

有关 Get-Help 命令语法图中显示的符号的信息，请参阅 about_Command_Syntax。 有关参数属性的信息，例如 必需 和 位置，请参阅 about_Parameters。

示例

示例 1：显示有关 cmdlet 的基本帮助信息

这些示例显示有关 Format-Table cmdlet 的基本帮助信息。

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

Get-Help <cmdlet-name> 是 Get-Help cmdlet 的最简单和默认语法。 可以省略 Name 参数。

语法 <cmdlet-name> -? 仅适用于 cmdlet。

示例 2：一次显示一页的基本信息

这些示例显示有关 Format-Table cmdlet 的基本帮助信息，一次一页。

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 的详细信息

这些示例显示有关 Format-Table cmdlet 的更详细的帮助信息。

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

详细 参数显示帮助文章的详细视图，其中包括参数说明和示例。

Full 参数显示帮助文章的完整视图，其中包括参数说明、示例、输入和输出对象类型以及其他说明。

详细 和 完整 参数仅对计算机上安装帮助文件的命令有效。 这些参数对概念性（about_）帮助文章无效。

示例 4：使用参数显示 cmdlet 的选定部分

这些示例显示 Format-Table cmdlet 帮助的选定部分。

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

Examples 参数显示帮助文件的 NAME 和 SYNOPSIS 部分以及所有示例。 无法指定示例编号，因为 示例 参数是开关参数。

参数 参数仅显示指定参数的说明。 如果仅指定星号（*）通配符，则会显示所有参数的说明。 当 参数 指定参数名称（如 GroupBy）时，将显示有关该参数的信息。

这些参数对概念性（about_）帮助文章无效。

示例 5：显示联机版本的帮助

本示例显示默认 Web 浏览器中 Format-Table cmdlet 的帮助文章的联机版本。

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-HelpPath 参数指定 SQL Server 提供程序的路径。 由于指定了提供程序的路径，因此可以从任何路径位置运行命令。

第二个示例使用 Set-Location 导航到 SQL Server 提供程序的路径。 从该位置，Get-Help 不需要 Path 参数来获取特定于提供程序的帮助。

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

-Component

-Detailed

-Examples

-Full

-Functionality

-Name

-Online

-Parameter

-Path

-Role

-ShowWindow

输入

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

• 位置。 指示参数是命名还是位置（数字）。 位置参数必须出现在命令的指定位置。

• 命名 指示参数名称是必需的，但该参数可以在命令中的任何位置显示。

• Numeric 指示参数名称是可选的，但在省略名称时，参数必须位于数字指定的位置。 例如，2 指示在省略参数名称时，参数必须是命令中的第二个或仅未命名的参数。 使用参数名称时，该参数可以出现在命令中的任意位置。

• 默认值。 如果命令中不包含参数，则 PowerShell 使用的参数值或默认行为。

• 接受管道输入。 指示是否可以（true）或无法（false）通过管道将对象发送到参数。 按属性名称 意味着管道对象必须具有与参数名称相同的属性。

• 接受通配符。 指示参数的值是否可以包含通配符，例如星号（*）或问号（?）。

相关链接

• about_Command_Syntax
• about_Comment_Based_Help
• Get-Command
• 支持可更新的帮助
• Update-Help
• 编写 Comment-Based 帮助主题
• 编写 PowerShell Cmdlet 的帮助