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 名稱> -<必要的參數名稱> <必要的參數值>
                       [-<選擇性的參數名稱> <選擇性的參數值>]
                       [-<選擇性的切換參數>]
                       [-<選擇性的參數名稱>] <必要的參數值>

      New-Alias Cmdlet 的語法如下：

          New-Alias [-Force] [-PassThru] [-Scope <字串>] 
              [-Option {None | ReadOnly | Constant | Private | AllScope}] 
              [-Description <字串>] [-Name] <字串> [-Value] <字串> 
              [-confirm] [-whatif] [<一般參數>]


      為了可讀性而以大寫表示語法，但是 Windows PowerShell 並沒有大小寫之分。


      參數按順序出現。只有當參數名稱為選擇項時，參數的順序才會顯著。如果使用 Cmdlet 
      時未指定參數名稱，Windows PowerShell 會依位置或型別將值指派給參數。


      參數名稱的前面有加連字號 (-)。切換參數不加數值型別。其他參數則有加必要引數的 
      Microsoft .NET Framework 型別或可能值的列舉。如需 .NET Framework 型別的詳細資
      訊，請參閱 https://go.microsoft.com/fwlink/?LinkId=143682。


      角括號 (<>) 表示預留位置文字。此文字可以描述 
      項目的型別 (如字串或 Process 物件)。也可以是一個或多個一般參數的預留位置。


      方括號 ([]) 表示選擇性的項目。參數可以省略，或者必要參數的名稱可以省略。切換
      參數一定為選擇項。


      大括號 ({}) 括住的是列舉值。以 New-Alias Cmdlet 為例，Option 參數可以有任何列
      出的值。


  選擇性的項目
      方括號 ([]) 括住的是選擇性的項目。例如，在 New-Alias Cmdlet 語法描述中 Scope 參
      數為選擇項。在語法中，其做法是以方括號括住參數名稱和型別：

          [-Scope <字串>]


      下列兩個範例都是 New-Alias Cmdlet 的正確用法：

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


      即使參數的值是必要的，參數的名稱也可以省略。在語法中，其做法是以方括號括住參
      數名稱但不括住參數型別，如 New-Alias Cmdlet 的下列範例所示：

          [-Name] <字串> [-Value] <字串>


      下列幾個命令都是 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] 
              [<一般參數>]


      Name 參數需要引數， 特別是需要服務的名稱，才能進行重新啟動。這個參數可以使用
      逗號分隔的服務清單，如下列範例所示：

          Restart-Service RasAuto, RasMan, RemoteAccess


請參閱
    Get-Help