CodeBuddy 提供四种注释方式:①快捷键(Mac:⌥+⇧+M;Win:Shift+Alt+M)一键生成单行/函数级注释;②/codes指令批量添加标准文档注释;③Craft智能体批量处理目录级注释;④自定义模板联动规范强制应用。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

CodeBuddy 添加代码注释有多种方式,操作直接、适配不同场景,不依赖复杂配置,关键在于选对方法并用准指令。
快捷键一键生成单行/函数级注释
适合快速为当前光标所在函数、方法或选中代码块添加基础说明。
- 选中一段代码(或把光标停在函数定义行)
- 按下对应快捷键:Mac 是 ⌥ + ⇧ + M,Windows 是 Shift + Alt + M
- 插件会自动分析语义,生成符合语言习惯的 JSDoc / JavaDoc / Python docstring 等格式注释
- 支持实时预览,确认无误后按回车应用
用 /comments 指令批量加文档注释
适合已有稳定结构的模块,想统一补全类、方法、参数说明等。
CodeBuddy Code CLI 的安装、配置与使用指南。CodeBuddy Code 是腾讯推出的 AI 驱动 CLI 编程助手,支持自然语言驱动开发。 - 必备触发词:CodeBuddy, codebuddy, AI CLI, Tencent AI coding, @tencent-ai/codebuddy-code, terminal AI assistant - 适用场景:安装 CodeBuddy CLI、配置 CodeBuddy、使用 CodeBuddy 命令、排查 CodeBuddy 问题
- 打开 CodeBuddy 对话框(如点击侧边栏图标或用 Ctrl + Windows + N)
- 输入 /comments,回车
- 系统自动识别当前编辑器中已选中的文件或代码区域
- 生成带 @param、@returns、@throws 等标准标签的完整文档注释,不改动逻辑代码
通过 Craft 智能体批量处理整个目录
适合接手老项目、重构阶段需为大量文件补注释,强调上下文一致性与业务语义。
- 安装腾讯云 AI 代码助手插件(VS Code 或 JetBrains)并重启
- 打开 Craft 对话界面,点击右上角 “Add”,勾选目标文件(支持多选)
- 输入明确话术,例如:
“这是订单服务的 Spring Boot 模块,包含 controller、service、mapper;请为每个类添加功能概述;为所有 public 方法添加参数和返回值说明;在涉及库存扣减、支付回调等关键逻辑处补充业务含义注释” - 发送后等待解析完成,预览确认再点击“应用更改”
自定义注释模板+规范联动
如果你的团队有统一注释规范(如必须含作者、创建时间、修改记录),可让 CodeBuddy 强制套用。
- 在设置中上传公司 code-style.json,启用「强制应用此规范」
- 触发注释生成时(快捷键或 /comments),自动插入预设模板,包括字段占位符
- 例如:生成的注释开头固定为 /**\n * @author ${user}\n * @created ${date}\n * @description */
- 后续还可配合 Git Hooks,在提交前自动检查注释完整性

















