コメントベースのヘルプキーワード

PowerShellで関数とスクリプトにコメントベースのヘルプを記述するときに使用するヘルプキーワード

キーワード 説明
.SYNOPSIS スクリプトの簡単な説明
.DESCRIPTION スクリプトの詳細な説明
.PARAMETER パラメータの説明 “.PARAMETER <Parameter-Name>”
.EXAMPLE スクリプトを使用するサンプルコマンド
.INPUTS コマンドレットにパイプ処理できる.NET型オブジェクト
.OUTPUTS コマンドレットが返すオブジェクトの.NET型
.NOTES スクリプトに関する追加情報
.LINK スクリプトの関連トピック
.COMPONENT スクリプトが使用するテクノロジまたは機能の名前
.ROLE スクリプトの役割
.FUNCTIONALITY スクリプトの使用目的

参考サイト:
about_Comment_Based_Help