接手新项目时,最耗时的往往是理清业务逻辑与代码组织方式。借助 CodeBuddy 由宏观到微观的穿透能力,通常 10–15 分钟即可建立对项目骨架的基本认知,避免在海量文件中盲目翻找。
第一步:生成项目地图
打开项目根目录后,先在侧边栏对话中输入:
“梳理一下这个项目的目录结构,说明各模块职责和核心入口在哪里。”
如果项目庞大,建议先通过 @目录 绑定项目根目录(见 3.4.2),再发起提问。CodeBuddy 会结合配置文件(如 package.json、pom.xml、go.mod 等)给出模块划分、技术栈版本、以及目录命名背后的约定,帮你快速建立全局视图。
第二步:精读核心链路
根据上一步得到的信息,打开主入口或核心业务文件(如启动类、路由配置、Service 层),选中关键代码块,使用代码逻辑逐行解释(见 3.3.1)。
建议粒度:以单个函数或类为单位(50–150 行),不要一次选中几百行。这样解释更精准,也便于你针对其中某一行继续追问。
第三步:追踪跨文件引用
遇到不熟悉的函数调用或接口实现时,在侧边栏选中该函数名提问:
“这个函数在哪里定义?作用是什么?被哪些模块调用?”
配合 @目录 或 @文件(见 3.4.1、3.4.2),AI 能在不离开当前文件的情况下,帮你定位实现位置并梳理调用链路,省去手动全局搜索(grep)的麻烦。
第四步:摸清业务规则与工程约定
继续向 AI 确认隐性的工程规范,例如:
- “这个项目的异常处理统一用什么方式?”
- “权限校验在哪一层实现?”
- “根据代码实际写法,这个服务的启动依赖哪些环境变量?”
相比可能过时的 README,基于代码实时的回答更能反映当前真实状况。
实用提示
- 先主链路,后工具函数:先搞清楚“请求从哪个入口进来、经过哪几层、最终如何落库或返回”,再按需深入 util、helper 等工具层。
- 链式追问:第一次回答通常是概括性的,不必满意就停止。可继续追问“刚才提到的订单状态机具体有哪几种状态、在哪里定义”,让对话逐层下钻。
- 及时固化认知:对话中获得的业务洞察(如“状态流转由 XXHandler 统一处理”)建议手动记录到项目笔记或 TODO 注释中,因为后续新对话可能会稀释当前上下文。