在 PowerShell 中使用 Show-Command 和 Get-Help

  • 10 分钟

Show-Command cmdlet 将打开一个窗口，其中显示命令列表或特定命令的参数。 此窗口与在 ISE 中选择“显示命令窗口”选项时显示的窗口相同。

若要显示特定命令的参数，请提供命令的名称作为 ‑Name 参数的值。 例如，若要使用用于检索 Active Directory 用户的命令打开“显示命令窗口”，请在控制台中输入以下命令，然后按 Enter 键：

Show-Command –Name Get-ADUser

–Name 参数是位置参数，供以下命令生成相同的结果：

Show-Command Get-ADUser

如果选择 ISE 中的“显示命令窗口”选项，且光标位于控制台或脚本窗格内的命令名称内或紧挨该名称，则结果将相同。

注意

在这些示例中，Show-Command 是实际运行的命令，而 Get-ADUser 是要在对话框中查看的命令的名称。

在“显示命令窗口”中，为指定的命令设置的每个参数都会显示在单独的选项卡上。这清楚地表明，不能在集之间混合和匹配参数。

为所有必需参数提供值后，可以通过在“显示”命令窗口中选择“运行”来立即运行该命令。 也可以通过选择“复制”将其复制到剪贴板。 可通过剪贴板将命令粘贴到控制台中，以便可在不运行命令的情况下查看正确的命令行语法。

请注意，Show-Command 还公开了 Windows PowerShell 通用参数，Windows PowerShell 将这些参数添加到所有命令中来提供一组预定义的核心功能。 在接下来的模块中，你将详细了解许多通用参数。 不过，若是想立即了解这些信息，请在 Windows PowerShell 中运行 help about_common_parameters，然后查看结果。

使用 Get-Help

Windows PowerShell 针对命令提供大量产品内帮助。 可使用 Get-Help 命令来访问此帮助。 Get-help 可在屏幕上显示所有帮助内容，并支持滚动浏览。 还可使用 Help 函数或 Man 别名，以映射到 Get-Help 命令。 这三个命令返回的结果基本相同。 这些结果包括 cmdlet 的简短和详细说明、语法、帮助作者提供的任何其他注解，以及相关 cmdlet 的链接或其他联机信息。 help 和 Man 命令在控制台中每次显示一页内容。 ISE 则显示全部帮助内容。

例如，若要显示 Get-ChildItem cmdlet 的帮助信息，请在控制台中输入以下命令，然后按 Enter 键：

Get-Help Get-ChildItem

Get-Help 参数

Get-Help 命令接受支持查找默认显示信息之外的其他信息的参数。 查找其他帮助的常见原因是为了确定命令的用法示例。 Windows PowerShell 命令通常包含许多这样的示例。 例如，运行命令 Get-Help Stop-Process –Examples 将提供使用 Stop-Process cmdlet 的示例。

-Full 参数提供有关 cmdlet 的详细信息，包括：

  • 每个参数的说明。
  • 每个参数是否具有默认值（不过此信息并非一致地记录在所有命令中）。
  • 参数是否是必需的。
  • 参数是否可接受特定位置的值（在这种情况下会给出从 1 开始的位置编号），或者是否必须输入参数名称（在这种情况下会显示命名参数）。
  • 参数是否接受管道输入；若接受，则还显示接受方式。

其他 Get-Help 参数包括：

  • ‑ShowWindow。 在单独的窗口中显示帮助主题，以便在输入命令时更容易访问帮助。
  • ‑Online。 在浏览器窗口中显示帮助主题的联机版本（通常是最新的信息）。
  • ‑Parameter ParameterName。 显示命名参数的说明。
  • ‑Category。 仅显示特定类别命令的帮助，如 cmdlet 和函数。

使用 Get-Help 查找命令

Get-Help 命令对于查找命令非常有用。 它接受通配符 (*, ?)，尤其是星号 (*) 通配符。 请求帮助并使用带有部分命令名称的通配符时，Windows PowerShell 将显示匹配帮助主题的列表。

通过使用先前了解的 cmdlet“动词-名词”结构的相关信息，可以使用 Get-Help 作为工具来发现 cmdlet（即使不知道它们的名称）。 例如，如果想要所有针对进程进行操作的 cmdlet，可以在控制台中输入命令 Get-Help *process*，然后按 Enter 键。 结果与命令 Get-Command *process* 返回的结果相匹配，但 Get-Help 显示摘要。 此摘要为简短说明，可帮助确认所需的命令。

有时，指定的通配符搜索可能与任何命令名称都不匹配。 例如，运行 Get-Help *beep* 将无法找到其名称中带有 beep 的任何命令。 如果未找到任何结果，帮助系统会执行针对可用命令说明和摘要的的全文搜索。 此类搜索将查找所有包含 beep 的帮助文件。 如果只有一个匹配文件，帮助系统会显示其内容，而非仅显示一个单项列表。 在搜索术语 beep 的案例中，Get-Help 返回了一个包含两个主题的列表：Set-PSReadlineOption（一个 cmdlet）和 about_Special_Characters（一个概念帮助主题）。