AgentSkillsCN

explain-code

用日语讲解代码的结构、逻辑与依赖关系

SKILL.md
--- frontmatter
name: explain-code
description: コードの構造・ロジック・依存関係を日本語で解説する
user-invokable: true

Explain Code — コード解説スキル

コードベースを深く理解するためのスキルです。

いつ使うか

  • 「このコードは何をしているの?」
  • 「このアルゴリズムを説明して」
  • 「このファイルの依存関係を教えて」

解説手順

Step 1: コンテキスト把握

bash
find . -type f -name "*.ts" | head -20

Step 2: コード読解

  1. 目的 — このコード/ファイルは何をするか
  2. 入出力 — 引数・戻り値・副作用
  3. アルゴリズム — 処理フローをステップで説明
  4. 設計判断 — なぜこの実装を選んだか
  5. 依存関係 — 何に依存し、何から依存されるか

出力形式

markdown
## 概要
[1-2行の要約]

## 詳細解説
[ステップごとの説明]

## 重要なポイント
- [注目すべき実装の詳細]

## 関連ファイル
- [依存するファイル一覧]

ヒント

  • @ファイル名 でファイルをコンテキストに追加してから質問すると精度が上がる
  • explore エージェントを使って関連ファイルを事前調査するとより深い解説が可能