| name | codebase-explorer |
| description | 中文代码库理解技能。用户要求读懂、分析、解释、梳理 C++、Java、Python、前后端或毕业设计项目时使用;专门输出模块结构、入口、调用链、类/函数职责、数据流、配置、依赖、测试和适合论文描述的系统结构。 |
代码库理解
使用这个技能帮助用户快速读懂一个系统,而不是只解释单个文件。
分析流程
-
建立地图
- 先列出目录结构、构建文件、配置文件和主要语言。
- 找到入口:
main、Controller、路由、CLI 命令、启动类、页面入口或测试入口。
-
追踪核心流程
- 从入口追踪到业务逻辑、数据访问、外部接口、输出结果。
- 标明关键文件、类、函数和调用顺序。
- 对 C++ 注意头文件/实现文件、CMake、对象生命周期。
- 对 Java 注意 Controller、Service、Repository、DTO、实体、配置。
- 对 Python 注意包结构、路由、服务函数、脚本入口、虚拟环境和依赖。
-
提炼模块职责
- 说明每个模块负责什么,和其他模块如何通信。
- 识别共享工具、配置、常量、异常类和中间件。
- 找出耦合较重、重复较多或边界不清的位置。
-
输出可用结论
- 给出“系统总体架构说明”。
- 给出“核心业务流程说明”。
- 给出“后续修改建议”和“优先阅读文件清单”。
输出模板
- 项目概览
- 技术栈与启动方式
- 模块结构
- 核心流程
- 数据模型/数据库/文件格式
- 关键文件清单
- 风险和改进建议
- 可写进论文的系统结构描述