第 1 卷

IDE插件CLIWorkBuddyWorkBuddy 小程序WorkBuddy 移动端企业版

Menu快速导航

常见工作流

学习 CodeBuddy Code的常见工作流程。

本文档中的每个任务都包含清晰的说明、示例命令和最佳实践，帮助您充分利用 CodeBuddy Code。

理解新代码库

快速了解代码库概况

假设您刚加入一个新项目，需要快速了解其结构。

步骤：

1.导航到项目根目录

bash

cd /path/to/project

2.启动 CodeBuddy Code

bash

codebuddy

3.询问高层次概览

> 给我这个代码库的概览

4.深入了解特定组件

> 解释这里使用的主要架构模式

> 关键的数据模型有哪些？

> 身份验证是如何处理的？

最佳实践：

从宏观问题开始，然后缩小到特定领域

询问项目中使用的编码规范和模式

请求项目特定术语的词汇表

查找相关代码

假设您需要定位与特定功能相关的代码。

步骤：

1.请 CodeBuddy查找相关文件

> 找到处理用户身份验证的文件

2.了解组件如何交互

> 这些身份验证文件如何协同工作？

3.理解执行流程

> 追踪从前端到数据库的登录过程

最佳实践：

对要查找的内容要具体

使用项目中的领域语言

高效修复Bug

假设您遇到了错误消息，需要找到并修复其来源。

步骤：

1.与 CodeBuddy分享错误

> 运行 npm test 时看到错误

2.询问修复建议

> 建议几种修复 user.ts 中 @ts-ignore 的方法

3.应用修复

> 更新 user.ts 添加你建议的空值检查

最佳实践：

告诉 CodeBuddy 重现问题的命令并获取堆栈跟踪

提及重现错误的任何步骤

让 CodeBuddy 知道错误是间歇性的还是持续性的

重构代码

假设您需要更新旧代码以使用现代模式和实践。

步骤：

1.识别需要重构的遗留代码

> 在代码库中查找已弃用的 API 使用

2.获取重构建议

> 建议如何重构 utils.js 以使用现代 JavaScript 特性

3.安全地应用更改

> 重构 utils.js 使用 ES2024 特性，同时保持相同的行为

4.验证重构

> 为重构的代码运行测试

最佳实践：

请 CodeBuddy 解释现代方法的好处

需要时请求更改保持向后兼容性