about_Command_Syntax

主题
    about_Command_Syntax

简短说明
    描述帮助中的 Windows PowerShell 语法表示法。


详细说明
    Get-Help cmdlet 显示 cmdlet 的参数用法。Get-Help cmdlet 使用以下特殊符号：

        尖括号 (<>) 指示占位符文本。
        方括号 ([]) 指示可选项。
        大括号 ({}) 指示从多个值中选择一个。


    某些 cmdlet 包含多个参数集。不同参数集可能有一些相同的参数。Get-Help cmdlet 显示 
    cmdlet 的所有参数集。


    您可以在参数说明和参数属性表中找到有关参数的其他信息。要查看有关参数的完整信息，请使用 
    Get-Help 的 Full 或 Parameter 参数。


  语法
      Windows PowerShell cmdlet 帮助、帮助主题和其他文档在语法说明中对 cmdlet 使用以下表
      示法。

          <cmdlet name> -<Required Parameter name> <Required parameter Value>
                       [-<Optional Parameter name> <Optional Parameter Value>] 
                       [-<Optional Switch Parameter>] 
                       [-<Optional Parameter Name>] <Required parameter Value>

      下面是 New-Alias cmdlet 的语法。

          New-Alias [-Force] [-PassThru] [-Scope <string>]
              [-Option {None | ReadOnly | Constant | Private | AllScope}]
              [-Description <string>] [-Name] <string> [-Value] <string>
              [-confirm] [-whatif] [<CommonParameters>]


      语法为便于阅读而采用了大写字母，但 Windows Powershell 并不区分大小写。


      参数是有顺序的。仅当参数名可选时参数的顺序才有意义。如果使用 cmdlet 时未指定参数名，则 
      Windows PowerShell 将按参数的位置和类型为参数赋值。


      参数名以连字符 (-) 开头。开关参数没有值类型。其他形式参数指定了所需实际参数的 
      Microsoft .NET Framework 类型，或指定可能值的枚举。有关 .NET Framework 类型的详细
      信息，请参阅 https://go.microsoft.com/fwlink/?LinkId=143682。


      尖括号 (<>) 指示占位符文本。此文本可以描述
      项目类型（如字符串或进程对象），还可以作为一个或多个通用参数的占位符。


      方括号 ([]) 指示可选项。参数可以是可选项，必需参数的参数名也可以是可选项。开关参数始终
      是可选的。


      枚举值用大括号 ({}) 括起来。在 New-Alias cmdlet 的示例中，可以对 Option 参数赋予列
      出的任何值。


  可选项
      可选项用方括号 ([]) 括起来。例如，在 New-Alias cmdlet 语法说明中，Scope 参数为可选
      项。在语法中用方括号将参数名和类型括起来指示了这一点：

          [-Scope <string>]


      以下两个示例都是 New-Alias cmdlet 的正确用法：

          New-Alias -Name utd -Value Update-TypeData
          New-Alias -Name utd -Value Update-TypeData -Scope global


      参数名可以是可选项，即使该参数的值为必需时也如此。在语法中用方括号括起参数名而不括起参数
      类型指示了这一点，如 New-Alias cmdlet 中的本例所示：

          [-Name] <string> [-Value] <string>


      以下命令都正确使用了 New-Alias cmdlet，并会产生相同的结果：

          New-Alias -Name utd -Value Update-TypeData
          New-Alias -Name utd Update-TypeData
          New-Alias utd -Value Update-TypeData
          New-Alias utd Update-TypeData


      如果键入的语句中不包括形式参数名，Windows PowerShell 将尝试根据实际参数的位置为形式参
      数赋值。


      下例所示命令是不完整的：

          New-Alias utd


      此 cmdlet 要求为 Name 参数和 Value 参数都进行赋值。


      在语法示例中，在命名和强制转换成 .NET Framework 类型时也用了方括号。在此上下文中，方
      括号并不指示元素为可选项。


  数组参数
      在语法说明中方括号也用于表示数组。以下示例说明 Restart-Service cmdlet 的语法：

          Restart-Service [-Name] <string[]> [-Include <string[]>] 
              [-Exclude <string[]>] [-Force] [-PassThru] [-Confirm] [-WhatIf] 
              [<CommonParameters>]


      形式参数 Name 需要一个实际参数。具体来说，它需要将重新启动的服务的名称。该参数可以采用
      由逗号分隔的服务列表，如下例所示：

          Restart-Service RasAuto, RasMan, RemoteAccess


另请参阅
    Get-Help