使用帮助系统发现命令

  • 1 分钟

通过使用 PowerShell 中的内置帮助系统，可以了解有关特定命令的详细信息。 使用 Get-Command cmdlet 可查找所需的命令。 找到命令后，你可能想要了解有关该命令的作用以及各种调用方法的详细信息。

使用帮助系统和 Get-help 发现 cmdlet

可使用 Get-Help 核心 cmdlet 来了解有关所选命令的详细信息。 通常，可通过按名称指定 Get-Help 并添加 -Name 标志（其中包含你想要了解的 cmdlet 的名称）来调用它。 下面是一个示例：

Get-Help -Name Get-Help

更新帮助

默认情况下，PowerShell 的新版本不包含帮助系统。 首次运行 Get-Help 时，系统会要求安装帮助文件。 你还可运行 Update-Help cmdlet 以安装帮助文件。 由于对 Update-Help 的调用会下载多个帮助文件，因此默认情况下，该命令每日只能提取一次。 可使用 -Force 标志重写此提取行为。

与 Linux 或 macOS 相比，在 Windows 上更新帮助文件的方式不同。 运行 Update-Help cmdlet 时，此过程将匹配计算机的区域性，以通过 Internet 获取帮助文件。 在 Windows 上，已经安装了一个区域性，但它在 Linux 和 macOS 上会丢失。 因此，在 Linux 和 macOS 上更新帮助文件时，需要指定一个区域性。

下面是一个示例命令：

Update-Help -UICulture en-US -Verbose

此命令指定 -UICulture 标志。 它为该标志提供值 en-US，这将提取英语帮助文件。 若要在 macOS 或 Linux 上更新帮助文件，请使用与你计算机的区域性相对应的区域性。

探索帮助部分

调用 cmdlet 上的 Get-Help 时，将返回帮助页。 此页面包含许多部分。 你可能会看到以下常见部分：

  • NAME：提供命令的名称。
  • SYNTAX：介绍如何通过使用标志组合（有时还可使用允许的参数）来调用命令。
  • ALIASES：列出了命令的所有别名。 别名是命令的不同名称，可用于调用命令。
  • REMARKS：提供有关要运行的命令的信息，以获取有关此命令的更多帮助。
  • PARAMETERS：提供有关参数的详细信息。 包括参数的类型、较长的说明和可接受的值（如果适用）。

筛选帮助响应

如果不想显示完整的帮助页面，可向 Get-Help 命令添加标志，以缩小响应范围。 下面是可以使用的一些标志：

  • Full：返回详细的帮助页面。 它指定了无法从标准响应中获取的参数、输入和输出等信息。
  • Detailed：返回与标准响应类似、但包含参数部分的响应。
  • Examples：仅返回示例（如果存在）。
  • Online：为命令打开一个网页。
  • Parameter：需要形参名称作为实参。 它列出特定参数的属性。

例如，可使用以下命令仅返回帮助页的“示例”部分。

Get-Help Get-FileHash -Examples

提升阅读体验

运行 Get-Help 命令将返回整个帮助页。 此页可能无法提供最佳阅读体验。 你可能必须滚动查找要阅读的部分。 更好的方法是使用 help 别名。 help 别名可将 Get-Help 传递到函数，确保输出逐行可读。 它还通过对输出进行分页，使响应逐页可读。 在下一个单元中使用别名 help。