← 返回目录

第 3 卷

第 3 / 8 卷日期:

> 运行新测试并修复任何失败

最佳实践:

要求涵盖边缘情况和错误条件的测试

适当时请求单元测试和集成测试

让 CodeBuddy 解释测试策略

创建合并请求

假设您需要为更改创建一个文档完善的合并请求。

步骤:

1.总结您的更改

> 总结我对身份验证模块所做的更改

2.使用 CodeBuddy生成 MR

> 创建一个 mr

3.审查并完善

> 用更多关于安全改进的上下文增强 MR 描述

4.添加测试详情

> 添加关于如何测试这些更改的信息

最佳实践:

直接让 CodeBuddy 为您创建 MR

提交前审查 CodeBuddy 生成的 MR

让 CodeBuddy 强调潜在的风险或考虑因素

处理文档

假设您需要为代码添加或更新文档。

步骤:

1.识别未文档化的代码

> 在认证模块中查找没有适当 JSDoc 注释的函数

2.生成文档

> 为 auth.js 中未文档化的函数添加 JSDoc 注释

3.审查并增强

> 用更多上下文和示例改进生成的文档

4.验证文档

> 检查文档是否符合我们的项目标准

最佳实践:

指定您想要的文档风格(JSDoc、docstrings等)

在文档中要求示例

为公共 API、接口和复杂逻辑请求文档

处理图片

假设您需要处理代码库中的图片,并希望 CodeBuddy 帮助分析图片内容。

步骤:

1.将图片添加到对话中您可以使用以下任一方法:

1.将图片拖放到 CodeBuddy Code窗口中

2.复制图片并用 ctrl+v 粘贴到 CLI 中(不要使用 cmd+v)

3.向 CodeBuddy 提供图片路径。例如:"分析这张图片: /path/to/your/image.png"

2.让 CodeBuddy分析图片

> 这张图片显示了什么?

> 描述这个截图中的 UI 元素

> 这个图表中有什么问题元素吗?

3.使用图片提供上下文

> 这是错误的截图。是什么原因造成的?

> 这是我们当前的数据库架构。我们应该如何为新功能修改它?

4.从视觉内容获取代码建议

> 生成与此设计稿匹配的 CSS

> 什么 HTML 结构可以重现这个组件?

最佳实践:

当文本描述不清楚或繁琐时使用图片

包含错误、UI 设计或图表的截图以获得更好的上下文

您可以在对话中处理多张图片

图片分析适用于图表、截图、原型设计等

引用文件和目录

使用 @快速包含文件或目录,无需等待 CodeBuddy 读取它们。

步骤:

1.引用单个文件

> 解释 @src/utils/auth.js 中的逻辑

这会在对话中包含文件的完整内容。

2.引用目录

全站分卷索引 · 8 卷
  1. 1第 1 卷
  2. 2第 2 卷
  3. 3第 3 卷
  4. 4第 4 卷
  5. 5第 5 卷
  6. 6第 6 卷
  7. 7第 7 卷
  8. 8第 8 卷