Github Source Decoder

仓库源码解读技能

sqliang 46ac060 7 files · 60.2 KB Updated

File contents

仓库源码解读技能

专门用于深度分析和解读本地或 GitHub 源代码仓库的技能。

工作原理

在 Claude Code 中全自动运行:

  1. **调用后无需中间交互,直接完成所有分析工作
  2. 使用脚本层做仓库准备和结构化数据输出
  3. Claude 通过工具调用进行智能分析和内容生成
  4. 输出分析报告、中文注释直接写入磁盘

使用方式

"帮我分析这个 GitHub 仓库:https://github.com/..."

或

"分析当前目录的代码"

输出结构

# 当使用 URL 模式时
~/github-sources/
└── repo-name/
    ├── reports/
    │   ├── 分析报告.md
    │   └── README-CN.md(如需要)
    └── [源代码文件(带中文注释)]

# 当使用当前目录模式时
./
├── reports/
│   ├── 分析报告.md
│   └── README-CN.md(如需要)
└── [源代码文件(带中文注释)]

分析报告内容

报告包含:

  1. 项目概述 - 项目用途、技术栈、主要功能
  2. 架构分析 - 目录结构、模块关系、设计模式
  3. 核心模块 - 关键文件和功能详解
  4. 依赖关系 - 主要依赖库及其用途
  5. 使用指南 - 如何运行、配置、使用
  6. 扩展建议 - 可能的改进方向

注释添加策略

为以下内容添加中文注释:

  • 复杂的算法逻辑
  • 设计模式的实现
  • 关键业务流程
  • 不易理解的代码段
  • 外部 API 调用

注释要详尽但不过度,解释"为什么"而不只是"是什么"。

sqliang/deep-insight-engines/tree/main/engines/repo-insight/github-source-decoder commit 46ac0603c0

Frequently asked questions

npx skillmds@latest add sqliang/github-source-decoder