コメントベースヘルプ

.SYNOPSISや.EXAMPLEなどのキーワード付きコメントを関数やスクリプトに書くことで、Get-Helpが標準コマンドレットと同じ形式でヘルプを表示する仕組み。

概念URI

https://comcomponent.com/knowledge/comment-based-help/

別名・表記

Comment-Based Help / .SYNOPSIS/.EXAMPLE

最終確認日

2026-08-01

機械可読データ

JSON-LD

この概念が関わる関係

• コメントベースヘルプは.psm1スクリプトモジュールに対する本記事の推奨です。他人に渡す・配布するモジュールにはコメントベースヘルプを書き、Get-Helpを効かせることが本記事の推奨である / 確度: 確立した関係 / 確認日: 2026-08-01 出典

この概念を扱う記事

• PowerShellスクリプトの引数設計とモジュール化 ── 「動くスクリプト」から「人に渡せるスクリプト」へ(言及)

一次資料

• https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help

このページはサイトの知識グラフ(_data/knowledge/)から自動生成されています。誤りの指摘はお問い合わせからお願いします。