← スキル一覧に戻る

explain-code
by ririnto
⭐ 0🍴 0📅 2026年1月22日
SKILL.md
name: explain-code description: 'Explain code operation, logic, and design clearly and systematically. Use when the user asks to explain code, understand how something works, what a function does, or requests logic analysis.' compatibility: Requires code reading tools allowed-tools: - Glob - Grep - Read - mcp__context7 - mcp__fetch - mcp__jetbrains - mcp__markitdown - mcp__serena
Code Explanation Skill
Explain code operation clearly and systematically.
Explanation Process
- Scope: locate file/function/class/block, map dependencies and calls;
use
mcp__serena__find_symbol,mcp__serena__find_referencing_symbols,mcp__jetbrains__get_symbol_infoas needed. - Structure:
- Overview(2-3 sentences): what/why/role.
- Flow: main logic, core algorithm, key branches.
- I/O: params, returns, side effects.
- Edge/limits: exceptions, boundaries, known limits.
- Usage: basic call, common patterns, integration points.
Explanation Level Adjustment
For Beginners
- Basic concepts, terminology definitions, detailed steps, analogies/examples
For Intermediate Developers (Default)
- Core logic 중심, 패턴/컨벤션 언급, 적정 추상화
For Advanced Developers
- Design rationale, performance, alternatives, trade-offs
Output Format
## Overview
[Purpose and role of the code]
## How It Works
### Main Flow
1. [First step]
2. [Second step]
...
### Core Logic
(key code excerpt with comments)
[Logic explanation]
## Input/Output
| Parameter | Type | Description |
|-----------|------|-------------|
| param1 | Type | Description |
**Return**: `Type` - Description
## Caveats
- [Edge cases or limitations]
## Usage Example
(example code)
Language-Specific Explanations
JavaScript/TypeScript
- Closures and scope
- Async patterns (Promise, async/await)
- Prototype chain
Python
- Decorators and context managers
- Generator patterns
- Magic methods
Java/Kotlin
- Object-oriented design patterns
- Generics and type variance
- Stream API
Go
- Goroutines and channels
- Interface implementation
- Error handling patterns
Edge Cases
- Complex code: Break into smaller chunks
- Library code: Reference official documentation
- Legacy code: Provide historical context if available
- Multi-language: Explain language-specific idioms
Tips
- MCP tools are optional; omit if unavailable or add others as needed
スコア
総合スコア
50/100
リポジトリの品質指標に基づく評価
✓SKILL.md
SKILL.mdファイルが含まれている
+20
○LICENSE
ライセンスが設定されている
0/10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
レビュー
💬
レビュー機能は近日公開予定です