在 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 或其他資訊的連結。 說明和 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 開始的位置編號），或者您必須輸入參數名稱（在此情況下會顯示 named）。
  • 參數是否接受管線輸入，如果接受的話，接收方式為何。

其他 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 時，Get-Help 會傳回兩個主題的清單：Set-PSReadlineOption，這是一個 cmdlet，和 about_Special_Characters，這是概念性幫助主題。