explain-code について
コードの挙動、アーキテクチャ、制御フローを理解したい開発者向けのスキルです。主要な抽象概念や前提、エッジケースを段階的に説明し、コード編集や正式な API ドキュメント作成には使用しません。
主な機能
- 01段階的なコード解説
- 02挙動・構成・制御フローの説明
- 03主要な抽象概念と前提の提示
- 04エッジケースの分析
活用シーン
- 01関数の挙動の理解
- 02コード構成の把握
- 03制御フローとエッジケースの追跡
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ cowork-os/ cowork-os --skill explain-codeインストール後、Claude Code で/explain-codeを入力して読み込まれたか確認します。
詳細
コードの説明
目的
コードの仕組みを詳しく説明します
振り分け
- 使用する場合:関数の動作、アーキテクチャ、制御フローについて概念的な説明を求められた場合に使用します。
- 使用しない場合:コードの編集や、厳密な正式 API ドキュメントの作成が必要なタスクでは使用しません。
- 出力:主要な抽象概念、前提、エッジケースの動作を含む、段階的な説明を提供します。
- 成功基準:過度な推測を避け、明確な用語を使い、求められたレベルでコードの意図に合った説明を行います。
トリガーの例
肯定的な例
- このリクエストには explain-code スキルを使用してください。
- explain code を使ってください。
- 関数の動作、アーキテクチャ、制御フローについて概念的な説明を求められた場合に使用します。
- コードの説明:実行可能な結果を提示してください。
否定的な例
- コードの編集や、厳密な正式 API ドキュメントの作成が必要なタスクでは使用しないでください。
- explain-code は無関係なリクエストには使用しないでください。
- このリクエストは explain code の対象外です。
- これは概念的な議論のみを求めているため、ツールのワークフローは必要ありません。
パラメーター
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| path | string | はい | 説明するファイルのパス |
| level | select | はい | 説明の詳しさ |
ランタイムプロンプト
- 現在のランタイムプロンプトの長さ:268 文字。
- ランタイムプロンプトは
../explain-code.jsonで直接定義されています。
コメント
Markdown 対応