在维护存量代码或推进多人协作时，补齐注释、统一风格往往耗时且容易遗漏。CodeBuddy 支持对函数、类及复杂逻辑块一键生成标准化注释，并可按选定范围批量处理。
触发方式
- 右键菜单：在编辑器中选中目标代码（单个函数、多个函数或整个文件），右键选择 CodeBuddy > 生成注释。
- 命令面板：按
Ctrl+Shift+P/Cmd+Shift+P，输入并选择 CodeBuddy: 标准化注释批量生成。 - 侧边栏对话：直接发送指令，如“为当前文件的所有方法添加 JSDoc 注释”，配合前文提到的
@文件引用即可定位处理范围。
生成范围与注释类型
工具会自动识别代码结构并匹配对应的注释模板：
- 函数/方法：提取参数、返回值、异常抛出等信息，生成包含
@param、@returns、@throws等字段的文档块。 - 类与接口：补充功能概述、关键属性说明，以及继承关系备注。
- 复杂逻辑段：对嵌套条件、正则表达式或业务规则密集处，自动插入行内注释，说明判断意图。
与团队规范联动
若项目已配置团队编码规范（参见 3.4.4 @规则），批量生成时会自动遵循指定模板。例如：
- 强制要求参数必须带类型说明；
- 统一使用
@author、@since等字段； - 指定描述语言为中文或英文。
个人项目则可在 设置 > 编辑器基础偏好设置 中，预设默认注释风格（如 JSDoc、Python DocString、C# XML 注释等）。
批量处理策略
- 全文件补齐：不选中任何内容直接触发命令，工具会遍历当前文件的所有顶层函数与类，一次性补充缺失的注释头部。
- 局部圈选：仅选中某几个函数，避免对已完成注释的模块重复生成。
- 规范化已有注释：追加指令“统一并规范化现有注释”，工具会在保留原意的基础上，调整格式与字段顺序，使其符合既定规范。
使用建议
- 生成后快速审阅：AI 对业务意图的概括可能不够精准，特别是涉及领域术语或复杂状态机时，建议人工微调描述。
- 避免过度注释：对纯 getter/setter 等简单存取方法，可在指令中补充“忽略简单方法”或手动跳过，保持代码简洁。
- 语言一致性：若已在 2.3.3 中设定“生成内容语言”为中文，批量生成的注释描述将自动以中文输出，无需每次重复指定。