codebuddy支持四种智能注释生成方式：一、ide插件批量加注释；二、圈选代码触发解释型注释；三、自定义指令标准化流程；四、figma mcp反向生成带注释前端代码。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您在开发过程中需要为大量已有代码快速添加规范、准确、上下文一致的注释，但手动编写耗时易错，则可借助 CodeBuddy 的智能注释生成能力实现自动化补充。以下是多种可行的操作路径：
一、通过 IDE 插件使用 Craft 功能批量加注释
该方法适用于 VS Code 或 JetBrains 系列 IDE，利用 Craft 智能体对选定文件或目录进行语义理解后，按结构化指令注入注释，不修改原有逻辑。
1、在 VS Code 或 IntelliJ IDEA 中安装【腾讯云AI代码助手】插件，安装完成后重启编辑器。
2、点击左侧或右侧边栏中的 CodeBuddy 图标，进入 Craft 对话界面。
3、点击对话框右上角的“Add”按钮，在弹出窗口中搜索并勾选需加注释的目标文件（支持多选）。
4、在输入框中粘贴适配后端或前端的专用话术（必须分点、明确边界）：
后端话术示例：这个是用户管理相关的类，包含 controller、service、serviceImpl、mapper、xml；解析这些文件，增加类级别注释；增加重要方法的注释；增加复杂业务逻辑处的注释；增加关键操作点的 log 日志打印；增加异常处理处的 log 日志记录；所有改动直接写入原文件，不变更任何原有代码逻辑
前端话术示例：这是 React 前端工程中订单模块的 tsx 和 less 文件；请在所有 ts、tsx、less 文件中添加合理注释；注释需覆盖组件功能、props 含义、关键状态作用、样式用途；所有注释必须直接写入对应文件，不得删改原代码
5、发送指令后等待模型完成解析与生成，确认预览无误后点击“应用更改”。
二、在编辑器内圈选代码片段触发解释型注释
该方式适合对局部函数、方法或逻辑块进行精准注释，基于实时上下文生成高相关性说明，适用于调试与交接场景。
1、在代码编辑区中用鼠标拖选目标函数体或关键逻辑段（如一个 useEffect 或一个 service 方法）。
2、在选中状态下，右键选择【腾讯云代码助手 > 解释代码】。
3、或在选中区域悬浮鼠标，点击弹出工具条中的“解释代码”图标。
4、也可在左侧 Craft 对话框中输入 /explain 并删除自动生成的 @ 符号，仅保留指令后回车。
5、模型返回结构化解释后，点击“插入为注释”按钮，注释将自动以 /** ... */ 或 // 形式添加至选中代码上方或内部合适位置。
三、使用自定义指令一键执行标准化注释流程
该方法面向团队统一规范场景，通过预置指令模板规避每次重复输入话术，确保注释风格、粒度、术语一致性。
1、在项目根目录下创建 .codebuddy/commands 目录（若不存在）。
2、新建文件 annotate-backend.md，内容包含完整注释策略与约束条件。
3、在文件中定义 description 字段说明用途，并设置 alwaysapply: false 与 enabled: true。
4、在 provider 部分嵌入结构化自然语言指令，明确要求：“仅添加 JSDoc 风格注释；跳过已存在注释的函数；对 public 方法强制添加 @param/@returns；对 catch 块强制添加 // LOG: 异常捕获 注释；所有输出必须写入源码，禁止生成 diff 或建议形式”。
5、保存后，在 Craft 输入框中输入 /annotate-backend 并执行，系统将自动加载该指令并运行。
四、结合 Figma MCP 流程反向生成带注释的前端代码
该路径适用于从设计稿起步的新建页面，CodeBuddy 在将 Figma 原型转为前端代码的同时，内置注释生成机制，使产出即具备可维护性。
1、确保已安装 CodeBuddy 插件并配置好 MCP Server（Framelink）及 Figma API Key。
2、在 VS Code 中打开空白文件夹，点击 CodeBuddy 图标，选择【MCP > 从 Figma 导入】。
3、选择已授权的 Figma 文件与具体页面，点击“生成代码”。
4、在生成配置界面中勾选 “启用自动生成组件级与函数级注释” 选项。
5、确认生成后，检查输出的 React 组件文件，可见每个组件顶部含功能描述注释，每个事件处理器含行为说明，每个样式模块含用途标注。
