人人都会AI编程

3.6.3 代码提交说明自动编写

更新时间:2026-06-30

在提交代码前,CodeBuddy 可基于当前 Git 暂存区(staged)的变更内容,自动生成结构清晰的提交说明。该功能适合频繁提交、需要保持提交历史整洁的团队,也适用于改动较多、一时难以准确概括修改意图的场景。

使用入口

  • 侧边栏快捷指令:在对话面板中点击"生成提交说明"按钮,或直接输入"写一下这次提交的 commit message"。
  • 源代码管理视图:在 VS Code 插件版的源代码管理(Source Control)面板中,右键点击变更文件选择相关选项;部分版本会在提交消息框旁提供生成图标。
  • 终端引用:在对话中使用 @终端 引用 git diff --staged 的输出结果,要求总结为提交说明(适用于桌面端或自定义工作流)。

生成逻辑与格式

工具会分析变更文件的类型、修改行数及语义差异,自动匹配合适的提交规范:

  • 简洁模式:输出一行概述,例如

fix(auth): 修复 token 过期后未正确跳转登录页的问题

  • 标准模式:采用 Conventional Commits 格式,包含标题、正文和关联模块,例如
  feat(order): 增加订单批量导出功能
  
  - 支持 CSV 与 Excel 两种格式导出
  - 添加导出权限校验与异步任务队列
  - 补充导出记录日志
  
  • 自定义模板:若团队已通过 @规则 导入内部提交规范(见 3.4.4),生成结果会自动套用组织规定的前缀、模块名与换行格式。

基础操作

  1. 完成代码修改,并执行 git add 将变更加入暂存区。
  2. 在 CodeBuddy 中唤起提交说明生成功能。
  3. 查看生成的内容,可直接复制使用;VS Code 插件版通常支持一键填入源代码管理面板的提交消息框。
  4. 若内容不符合预期,可在对话中追加指令微调,例如"再简洁一些"、"用英文重写"或"把 Breaking Change 标注出来"。

实用提示

  • 以暂存区为准:生成内容严格基于已 staged 的 diff。若暂存区为空,部分版本会基于最近一次提交后的全部工作区变更生成,但建议养成先 add 再生成的习惯,避免无关文件混入说明。
  • 语言跟随设置:输出语言受编辑器基础偏好设置中的"生成内容语言"选项控制(见 2.3.3)。中文团队建议提前设为中文,避免中英混杂。
  • 拆分建议:若一次改动跨越多个模块,可要求"按功能拆分为多条提交建议",CodeBuddy 会给出拆分方案及各自的提交说明草案,方便你分步执行 git add -p 与多次 commit。
  • 安全注意:生成过程需读取代码 diff,若涉及敏感配置(如密钥、内部接口地址),建议先在本地审查变更,脱敏后再使用该功能。