← 一覧へ
🔍 コードを理解するCodex難易度: 中級
教育的コメントの追加 add-educational-comments
コードを学びの場に変える魔法のコメント
これは何？
これは、プログラミング学習をサポートするためのツールです。コードファイルに教育的なコメントを追加することで、初心者でもコードの意味や仕組みを理解しやすくなります。ファイルの構造やエンコーディングはそのままに、わかりやすい解説を加えます。学習のレベルに応じて説明の深さを調整することも可能です。
これでできること
- コードの各行にわかりやすい解説を追加します
- 初心者向けに基本的な概念を説明します
- 上級者向けにパフォーマンスや設計に関する洞察を提供します
- コードのベストプラクティスを提案します
- 関連する概念を繰り返し説明することで理解を深めます
こんな時に便利
プログラミングを教える教材を作るとき
他人のコードを理解する必要があるとき
自分で書いたコードを後で見返すときに備えて
コードレビューの際に学習ポイントを明確にするとき
チームメンバーのスキルアップを支援するとき
使い方
使用するには、コードファイルを指定するだけでOKです。ファイルが指定されていない場合は、適切なファイルを選択できるようにサポートします。コメントの詳しさや繰り返しの頻度など、学習目的に応じて設定を調整することも可能です。
使用例（こう頼んでみよう）
/add-educational-comments #file:example.py/add-educational-comments Comment Detail = 1, Repetitiveness = 1/add-educational-comments #file:output_name.py Educational Level = 3必要なもの
- 特になし
導入方法
いちばん簡単（AIに頼む）
次のスキルを入れて: https://github.com/github/awesome-copilot/tree/main/skills/add-educational-comments手動で置く
Claude Code →
~/.claude/skills/add-educational-comments/Codex →
~/.agents/skills/add-educational-comments/使いこなしのコツ
- 学習者のレベルに応じてComment Detailの値を調整しましょう
- 重要な概念はRepetitivenessの値を上げて繰り返し説明するのが効果的です
- ファイルが大きい場合は、コメント数を300行以下に抑えることをお勧めします