Get-Help:最も人気のあるPowerShellコマンドをマスターする

新参者もエキスパートも、PowerShellのヘルプコマンドであるGet-Helpにはなじみのあるものはありません。PowerShellの統合および更新可能なヘルプシステムのおかげで、PowerShellのGet-Helpコマンドは、コマンドの機能やパラメータ、そして(おそらく)コマンドの使用方法に関する便利な例を見つける方法です。

出会うすべてのコマンドと関数には、Get-Helpコマンドで読み取ることができるヘルプコンテンツが組み込まれているはずです。私は「はず」と言っていますが、残念ながら、一部の作者はヘルプコンテンツを含めていません。

コマンドに関連するヘルプコンテンツは、Get-Helpを実行することで見つけることができます。このコマンドは、コマンドまたは関数の作者が作成したコメントベースおよびXMLベースのヘルプを読み取ります。

最も一般的なGet-Helpコマンドの使用方法は、特定のコマンドのヘルプコンテンツを検索するために使用することです。たとえば、Get-CommandコマンドでGet-Contentという新しいコマンドを見つけ、それについての詳細情報を知りたい場合は、Get-HelpNameパラメータを使用します。これにより、以下のようにそのコマンドの基本的な情報が返されます。

Get-Help -Name ‘Get-Content’

多くの情報が返されることに気付くでしょうが、それはできることの要約に過ぎません。そして、Get-Helpが例のような他の種類のヘルプコンテンツも返すことを知ることはありません。

パラメータ情報の検索

ヘルプコンテンツには、いくつかの方法で詳細を掘り下げることができます。ここで使用している例では、Rawパラメータの参照があり、そのパラメータの動作がよくわかりません。その特定のコマンドパラメータに関する情報のみを返すために、Get-HelpParameterパラメータとNameパラメータを使用できます。

Getting help with parameters

PowerShellのGet-Helpと例

PowerShellのヘルプシステムの最も良い点の1つは、例のネイティブサポートを持っていることです。例は特定のコマンドの使用方法を文脈とともに確認するための優れた方法です。コマンドの作成者がヘルプコンテンツに例を追加した場合、Examplesパラメータを使用してそれらの例を表示できます。このパラメータを使用すると、Get-Helpはそのコマンドが異なる状況でどのように使用されるかの1つ以上の例を返します。

Get-Help -Examples

詳細なヘルプの取得

概要、パラメータ情報、例だけがPowerShellのGet-Helpコマンドによって返される情報ではありません。時には、コマンドレットに利用可能なすべての情報を表示する必要があります。その場合、常にDetailedパラメータとFullパラメータを使用できます。それぞれのパラメータは、より多くの情報を表示します。

詳細パラメーターは、主要なヘルプ表示にパラメーターの説明と例を追加します。基本的には、パラメーターの使用と組み合わせて、コマンドのすべてのパラメーターに対してパラメーターパラメーターを使用したかのように、すべてのパラメーターの情報を表示します。

詳細パラメーターでは十分ではない場合は、常に核のアプローチを取り、フルパラメーターですべてのヘルプコンテンツを返すことができます。このパラメーターは情報を一切フィルタリングしません。フルパラメーターは、特定のコマンドに定義されたすべてのヘルプコンテンツを読み取ります。

グラフィカルな表示

ヘルプのよりグラフィカルな表示を希望する場合は、ShowWindowパラメーターも使用できます。このパラメーターは、ヘルプコンテンツを簡単に検索し、設定ボタンを使用して特定の領域のみ表示するウィンドウを表示します。この表示は、ヘルプコンテンツの調査を行いたい場合に役立ちます。

Get-Help -ShowWindow

概要

PowerShellのGet-Helpコマンドには、他にもいくつかの一般的でないパラメーターがあります。詳細情報を学びたい場合は、その追加のパラメーターに関する情報を見つける方法を知っていますよね?はい、Get-Helpは自分自身に関するヘルプコンテンツを見つけることができます。

PowerShellのコマンドに関する詳細情報を探すときには、Get-Helpコマンドを熱心に使用してください。強力なヘルプシステムとそれにアクセスするためのコマンドがあるので、Googleに行く必要はほとんどありません。

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