当你接手一个陌生项目,或需要向协作者介绍现有工程时,快速建立对整体架构的认知是高效开发的前提。CodeBuddy 支持通过对话方式对项目结构进行自动化分析,无需手动逐层展开目录、翻阅各个 README。
核心用法
在侧边栏对话中,通过 @目录(参见 3.4.2)绑定项目根目录,随后提出具体梳理需求。常用指令示例:
- "简要说明这个项目的模块划分和各部分职责"
- "找出核心入口文件、配置文件,并说明作用"
- "分析各业务模块之间的依赖关系,按调用层级排序"
- "这个项目用了什么技术栈?框架版本和构建工具是什么?"
典型输出
CodeBuddy 会结合目录层级、关键配置文件(如 package.json、go.mod、pom.xml、pyproject.toml 等)以及源码中的模块注释,输出结构化的总结,通常包括:
| 输出维度 | 说明 |
|:---|:---|
| 技术栈识别 | 语言版本、框架、构建工具、数据库与中间件 |
| 目录职责 | 各顶层文件夹(如 src/、cmd/、internal/、tests/)的边界与用途 |
| 模块关系 | 核心业务模块间的调用流向与分层架构(如 Controller → Service → DAO) |
| 关键文件索引 | 入口文件、路由注册、全局配置、公共工具库的具体位置 |
操作示例
- 打开侧边栏对话面板,输入
@目录并选择项目根目录。 - 发送指令:"请梳理这个项目的整体结构,重点关注业务模块划分。"
- 获得高层概览后,若对其中某一模块存疑,可继续追问:"再详细说明一下
payment模块的代码组织方式,以及它依赖了哪些外部服务。"
实用技巧
- 先读配置,再看代码:如果项目目录混乱、缺乏文档,优先让 CodeBuddy 分析构建配置和
README,往往比直接扫描源码更快抓住关键架构。 - 生成可视化文本:要求以树状文本图或 Mermaid 流程图格式输出模块关系,可直接粘贴进技术文档或分享。
- 增量探索,避免过载:大型项目不要一次性要求"解释所有代码"。先获取高层架构图,再针对具体模块深入展开,防止因上下文过长导致细节丢失。
- 关注"高频修改"区域:可追问 "哪些目录的代码变更最频繁?",结合文件修改时间辅助判断核心与边缘模块。