自动注释功能可以一键为选中的代码生成标准化注释,支持函数头说明、行内逻辑标注、官方文档格式注释等多种形式,不用手动逐行编写。特别适合补全旧代码注释、统一团队代码风格、降低后续维护成本,新手也能快速写出规范的注释。
一、三种触发方式,按需选择
功能入口与代码解释、Bug修复保持一致,不用额外记忆操作,选中代码即可一键触发。
1. 悬浮工具栏(小段代码快速添加)
适合单个函数、单段逻辑的快速注释,操作最快:
- 用鼠标选中需要加注释的代码片段;
- 代码右侧弹出悬浮工具栏,点击「添加注释」按钮;
- 侧边栏会生成带注释的完整代码,核对后可一键替换回原文件。
2. 右键菜单(批量代码首选)
适合选中多个函数、大段逻辑的批量注释,操作最直观:
- 选中目标代码范围(可选中多个函数,也可全选整个文件内容);
- 点击鼠标右键,选择「Codex → Add comments(添加注释)」;
- 等待生成后,侧边栏输出带完整注释的代码,确认无误后替换原代码即可。
3. 侧边栏对话(自定义注释风格)
需要指定注释格式、详细程度、特殊规范时使用,支持个性化定制:
- 选中目标代码后打开 Codex 侧边栏;
- 输入自定义要求,比如“给这段代码加上 JSDoc 格式的函数头注释,关键逻辑补充行内中文注释”;
- 生成后可反复调整要求,直到符合预期风格。
二、常用场景指令模板(直接套用)
根据不同需求选择对应指令,生成的注释更贴合实际使用:
- 通用函数注释:给每个函数添加功能说明、入参说明、返回值说明,全部用中文
- 标准文档注释:按照 JSDoc 规范生成函数注释,包含 @param、@returns、@example
- Python 文档注释:按照 Google 风格给函数添加 docstring 格式注释
- 精简行内注释:只给核心复杂逻辑加行内注释,简单功能不冗余说明
- 旧代码优化:精简现有注释,删除重复废话,只保留业务关键信息
三、提升注释质量的实用技巧
- 提前设置语言偏好
在插件设置中将「注释语言」设为简体中文,后续一键生成的注释默认就是中文,不用每次额外说明。
- 按粒度分批处理
不要一次性选中整个文件所有代码,建议按函数、按模块分批生成,注释准确率更高,也方便逐段核对业务逻辑。
- 明确指定规范
团队开发时,统一指定注释标准,比如“每个函数必须标注功能、入参、返回值、异常场景”,生成的注释风格统一,方便多人协作维护。
- 同步补充业务说明
核心业务代码可以在指令里加上背景,比如“这是用户支付回调的逻辑,注释里要标注清楚业务状态流转规则”,注释不仅讲清代码,也说明业务意图。
四、常见问题与处理
- 生成的注释是英文
先检查插件设置中的「注释语言」是否设为中文;也可以在指令里明确加上“所有注释使用中文”。
- 注释太啰嗦,都是重复废话
补充指令重新生成:“精简注释,只保留核心逻辑说明,简单语法不用解释,保持简洁”。
- 注释格式不符合团队规范
明确指定规范名称,或粘贴一段你们的标准注释当示例,比如“按照下面的注释格式风格生成:[粘贴示例]”,AI会对齐风格。
- 大段代码生成不完整
把代码拆成 2~3 个逻辑块分批处理,先生成所有函数的头注释,再补充核心行内注释,比一次性全选效果更好。
实用小提示:生成注释后建议快速扫一遍再替换,核心业务逻辑可以手动补充业务背景,后续自己改需求、交接项目时会省心很多。