獲取說明:掌握最受歡迎的 PowerShell 命令

沒有比 PowerShell 幫助命令 Get-Help 更為熟悉的命令,這對新手和專家來說都是如此。由於 PowerShell 內置且可更新的幫助系統,PowerShell 的 Get-Help 命令是您發現命令功能、其參數甚至(希望如此的話)大量有用示例的方法。

您遇到的每個 cmdlet 和函數都應該有與之搭配的幫助內容,這些內容可以由 PowerShell Get-Help 命令讀取。我說“應該有”是因為不幸的是,有些作者並未包含幫助內容。

與命令相關的幫助內容可以通過運行 Get-Help 命令來查找。此命令可以讀取命令或函數作者創建的基於註釋和基於 XML 的幫助內容。

Get-Help 命令最常見的用法是使用它來查找特定命令的幫助內容。例如,也許您已經使用 Get-Command 命令發現了一個名為 Get-Content 的新命令,並想要了解更多信息。您可以在 Get-Help 上使用 Name 參數。這將返回有關該命令的基本信息,如下所示。

Get-Help -Name ‘Get-Content’

你會注意到雖然返回了很多信息,但這只是你可以做的事情的摘要。而你永遠不會知道 Get-Help 還可以返回其他類型的幫助內容,比如示例。

查找參數信息

你可以通過幾種不同的方式深入了解幫助內容。其中一種方式是查找有關命令單個參數的信息。也許在我這裡使用的示例中,我看到對 Raw 參數的引用,並不太確定該參數的作用。我可以使用 Get-HelpParameter 參數和 Name 參數,僅返回有關該特定命令參數的信息。

Getting help with parameters

PowerShell Get-Help 和示例

PowerShell 幫助系統最好的一點是它對示例有本地支持。示例是查看如何使用特定命令的一種很好的方式,有上下文的方式。如果命令的作者在幫助內容中添加了示例,你可以使用 Examples 參數查看這些示例。使用此參數時,Get-Help 將返回該命令在不同情況下的一個或多個示例。

Get-Help -Examples

獲取冗長幫助

摘要、參數信息和示例並不是 PowerShell Get-Help 命令返回的唯一信息。有時,你需要查看命令碼完全可用的所有信息。在這種情況下,你總是可以使用 DetailedFull 參數。這兩個參數中的每一個都顯示更多的信息。

參數Detailed將參數描述和示例添加到主要的幫助顯示中。本質上,它們結合了使用Examples參數,並將顯示所有參數的信息,就好像您在所有命令參數上使用了Parameter參數一樣。

如果Detailed參數不夠用,您總是可以採取核子方法,並使用Full參數返回所有幫助內容。此參數不會過濾信息。Full參數會讀取為特定命令定義的所有幫助內容。

獲取圖形

如果您希望以更圖形化的方式查看幫助,您還可以使用ShowWindow參數。此參數會彈出一個窗口,讓您可以輕鬆搜索幫助內容,並通過設置按鈕僅顯示特定區域。如果您真的想要進行幫助內容的偵察,這種視圖非常有用。

Get-Help -ShowWindow

總結

您還可以使用一些其他不太常見的參數與 PowerShell 的Get-Help命令一起使用。如果您想了解更多,您知道如何查找有關這些額外參數的信息,對吧?是的,Get-Help可以找到有關自身的幫助內容。

在查找有關 PowerShell 命令的更多信息時,請堅持使用Get-Help命令。當您有一個強大的幫助系統和一個可以幫助您利用它的命令時,就沒有必要去谷歌了。

Source:
https://adamtheautomator.com/powershell-get-help/