Helpの見方

PowerShellのコマンドレットのHelpを見るにはいくつかの方法があります

ヘルプの見方

PS> Get-Help Get-ChildItem

PS> Get-ChildItem -?

以下は、デフォルトで定義されている関数を使った方法です。
Get-Helpと同様の機能とパラメーターがある。さらにページ送りの機能を持ちます。

PS> help Get-ChildItem

PS> man Get-ChildItem

スクリプトのコメントベースのヘルプ

コメントベースのヘルプが記述されているスクリプトや関数であれば、上記の方法で参照できます。スクリプトを使う人のために、コメントを記述しておくと良いと思います。

Example

以下のようなスクリプトがあるとします。

script.ps1

<#
.SYNOPSIS
    Short description
.DESCRIPTION
    Long description
.EXAMPLE
    PS C:\> <example usage>
    Explanation of what the example does
.INPUTS
    Inputs (if any)
.OUTPUTS
    Output (if any)
.NOTES
    General notes
#>
Write-Host "Hello!"

Get-Helpをこのスクリプトに対して実行すると以下のようになります。

PS C:\Users\user\Desktop> Get-Help Script.ps1
 
NAME
    C:\Users\user\Desktop\script.ps1
 
SYNOPSIS
    Short description
 
 
SYNTAX
    C:\Users\user\Desktop\script.ps1 [<CommonParameters>]
 
 
DESCRIPTION
    Long description
 
 
RELATED LINKS
 
REMARKS
    To see the examples, type: "get-help C:\Users\user\Desktop\script.ps1 -examples".
    For more information, type: "get-help C:\Users\user\Desktop\script.ps1 -detailed".
    For technical information, type: "get-help C:\Users\user\Desktop\script.ps1 -full".

参考：Visual Studio Codeの場合「comment-help」でコメントベースのヘルプのスニペットを入力できる。

YouTube

動画による説明はこちら。