外观
AI辅助编程
CodeBuddy入门
选择自己喜欢的、熟悉的AI辅助编程工具即可。下面以腾讯 CodeBuddy 为例说明。
CODEBUDDY.md
仓库根目录的 CODEBUDDY.md.example 是模板,描述了项目目标、架构分层、编码规范、与 AI 的约定。将其复制为 CODEBUDDY.md ,默认每次对话会将原文全文放入上下文。
其中“与 AI 编程助手的约定”最关键的一条是:遇到大的修改,先给出修改 / 设计方案,确认后再修改代码。这条约定能在动手前暴露理解偏差,避免大规模返工。
powershell
cp CODEBUDDY.md.example CODEBUDDY.md项目规则
项目规则存储在代码库的 .codebuddy/rules 目录中,受版本控制管理,可以与团队成员共享。按需要自行创建。
代码库本身
当文档与代码存在歧义时,以代码为准。AI 助手会优先参考既有模块的“代码风格示例”(如 module_infra/file_config 下的 controller / service),保持新增代码与存量风格一致。
高效协作模式
先设计,后动手
对于跨多文件、影响核心流程的改动,先让 AI 给出方案。一个高效的请求方式:
“我要新增一个 XX 模块,包含列表分页、新增、编辑、删除。请先给出目录结构、各文件职责与涉及的数据表字段,确认后再写代码。”
AI 会先产出设计,你确认无误后再进入实现,避免大段返工。
给 AI 足够的上下文
AI 的产出质量高度依赖上下文。有效的做法:
- 指明涉及的目录或文件(如“在
module_infra下参考file_config新增xx_config”)。 - 贴出报错信息、期望行为、相关接口约定。
- 对模糊需求,主动补充业务背景,减少 AI 的猜测空间。
分而治之
把大需求拆成小任务逐个推进,每步都可验证:
AI 辅助开发工作流
以“新增一个后端业务模块”为例,推荐协作流程:
- 提需求:描述功能、字段、接口形态,参考既有模块。
- 审设计:AI 给出目录、命名、数据表与字段设计,你确认。
- 写代码:AI 按约定生成 model / schema / crud / service / controller。
- 查代码:运行 ruff 格式化与检查,处理类型 / 未使用变量。
- 跑测试:必要时运行 pytest 或端到端用例。
- 交付:确认行为符合预期后提交。
模型选择
- 日常开发:GLM-5.3-Flash 或 DeepSeek
- 设计阶段:GLM-5.3