コードコメント規約

この skill は、このリポジトリでソースコードのコメントを追加、編集、レビュー、削除判断するときに使う。

基本方針

コード内コメントは常に WHY だけを書く。WHAT はコードから読み取れる前提にする。

コメントは、コードだけでは読み取れない文脈を未来の作業者に渡すためのものとして扱う。処理内容の説明が必要に見える場合は、まず命名、関数分割、型、テストで読みやすくできないかを優先する。

コメントしてよい内容

次のような、コードから読み取れない理由や背景だけをコメントに残す。