☰

如何阅读 PowerShell 文档语法

tag-icon • tag-icon powershell documentation syntax man
如何阅读 PowerShell 文档语法

我可以使用 PowerShell 文档语法的良好解释：

> man Update-Help

SYNTAX
    Update-Help [[-Module] <string[]>] [[-SourcePath] <string[]>] [[-UICulture] <cultureinfo[]>] [-Recurse] [-Credential <pscredential>] [-UseDefaultCredentials] 
    [-Force]  [<CommonParameters>]

    Update-Help [[-Module] <string[]>] [[-UICulture] <cultureinfo[]>] [-LiteralPath <string[]>] [-Recurse] [-Credential <pscredential>] [-UseDefaultCredentials] 
    [-Force]  [<CommonParameters>]

因此我尝试更新一下：

> Update-Help Get-ChildItem

错误：

Update-Help : No Windows PowerShell modules were found that match the following pattern: Get-ChildItem. Verify the pattern and then try the command again.At line:1 
char:1
+ Update-Help Get-ChildItem
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (Get-ChildItem:String) [Update-Help], Exception
    + FullyQualifiedErrorId : ModuleNotFound,Microsoft.PowerShell.Commands.UpdateHelpCommand

我特别想知道哪些参数是强制的，这些参数的类型是什么，以及它们是否需要按照特定的顺序出现？

答案1

man 更新帮助

首先要记住，默认情况下，man（实际上是 Get-Help）不会向您显示可用于命令行的完整帮助。基本输出无法以易于阅读的方式提供您所需的信息。

如果您使用Get-Help Update-Help -online或 ，Get-Help Update-Help -ShowWindow您将获得更详细的信息。其中一条信息是每个参数的列表、它们的位置（如果它们可以在没有 的情况下使用-param）、是否是必需的、默认值等等。

您还可以使用类似的东西直接获取有关特定参数的详细信息Get-Help update-help -Parameter module。

Get-Help我认为 真正有用的部分是示例部分。get-help update-help -Examples这通常会为您提供一堆如何使用命令行的示例。

由于所有 powershell 文档都在线，因此通常只需进行 Google/Bing 搜索即可powershell update-help获得指向在线文档我认为它是完整的，并且更容易阅读。

更新帮助获取 ChildItem

这失败了，因为Get-ChildItem这是一个命令行，而不是模块。您可以简单地不使用任何参数，它会更新所有内容。或者您可以找到所属的Update-Help模块，然后更新该模块。Get-ChildItem

PS C:\users\public> get-command get-childitem

CommandType Name          Version Source
----------- ----          ------- ------
Cmdlet      Get-ChildItem 3.1.0.0 Microsoft.PowerShell.Management

PS C:\users\public> Update-Help -Module Microsoft.PowerShell.Management
PS C:\users\public>

相关内容