PowerShell Get-Help

PowerShell Get-Help cmdlet 用于显示有关 PowerShell 命令和概念的信息。 它显示信息，包括 cmdlet 的函数、提供程序、工作流、脚本和别名。 要获取 PowerShell cmdlet 的帮助，请键入 Get-Help，后跟 cmdlet 的名称，例如：Get-Help Set-Item。 我们还可以获取 PowerShell 提供程序的帮助，键入 Get-Help cmdlet，后跟提供程序名称。

语法

参数

-Name

-Name 参数用于获取有关指定命令或概念的帮助。

-Path

-Path 参数用于获取解释 cmdlet 在指定提供程序路径中如何工作的帮助。 要使用此参数，我们可以为包含提供程序的模块安装帮助文件。

-Category

-Category 参数用于仅显示存在于指定类别及其别名中的那些项目的帮助。 以下是此参数的可用值

• 全部
• DefaultHelp
• 工作流程
• DscResource
• Class
• 别名
• 词汇表
• HelpFile
• ScriptCommand
• 函数
• Filter
• Cmdlet
• Provider
• 常规
• 常见问题解答
• ExternalScript
• 配置

-Component

-Component 参数用于显示具有给定组件值的命令。 接受通配符。

-Functionality

-Functionality 参数用于显示具有给定功能的项目的帮助。 接受通配符。

-Role

-Role 参数用于显示为指定用户角色定制的帮助。 接受通配符。

-Full

-Full 参数用于显示 cmdlet 的整个帮助文章。 仅当计算机上安装了帮助文件时才有效。

-Detailed

-Detailed 参数用于将示例和参数说明添加到基本帮助显示中。

-Examples

-Examples 参数用于仅显示名称、概要和示例。

-Parameter

-Parameter 是一个参数，仅显示给定参数的详细说明。

-Online

-Online 参数用于在默认浏览器中显示帮助文章的在线版本。 它仅对函数、cmdlet、工作流和脚本帮助文章有效。 我们不能在远程会话中使用此参数和 Get-Help cmdlet。

示例

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

此示例中的 cmdlet 用于在 PowerShell 控制台上显示有关 get-Item cmdlet 的基本帮助信息。

示例 2：显示有关 cmdlet 的更多信息

此示例中的 cmdlet 用于显示有关 get-Item cmdlet 帮助的更详细信息。

-Detailed 参数在此 cmdlet 中用于显示帮助文章的详细视图，其中包括参数说明和示例。

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

示例 3：显示 cmdlet 的选定部分

此示例中的 cmdlet 用于显示 get-Item cmdlet 的选定部分。

示例 4：显示 cmdlet 帮助的在线版本

此示例中的 cmdlet 用于在默认 Web 浏览器中显示 get-Item cmdlet 帮助文章的在线版本。

示例 5：显示有关 PowerShell 帮助系统的信息

此示例中的 cmdlet 用于显示有关 PowerShell 帮助系统的信息。

示例 6：显示可用的帮助文章

此示例中的 cmdlet 用于显示计算机上可用的帮助文章列表。