CodeBuddy支持函数级一键生成结构化文档注释、批量为多文件补全注释、自然语言驱动语义注释、局部代码块解释性注释四种方式，覆盖从单函数到整个模块的工程化注释需求。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要为已有函数快速补全符合工程规范的详细注释，避免手动逐行编写耗时且容易遗漏关键参数说明或异常场景。
函数级一键生成结构化文档注释
这一步适合刚写完但还没加任何注释的单个函数，CodeBuddy 会自动识别参数类型、返回值、可能抛出的异常，并按 PEP 257 或 JSDoc 标准生成带字段标记的注释块。
1、将光标置于函数名所在行，或用鼠标完整选中函数定义（含 def/function 关键字、签名及首行缩进后的代码块）。
2、右键 → 选择 【Generate Doc】 菜单项。
3、AI 分析完成后，注释将直接插入函数顶部，格式为："""... :param name: ... :raises ValueError: ... """ 或 /** @param {string} name - ... */。若函数无明确返回值，系统不会强行添加 @return 字段，这点比人工写更严谨。
批量为多个文件补全注释
当你面对一个遗留模块里十几二十个没注释的 .py 或 .ts 文件时，这个方法能一次性处理全部，省去反复打开、选中、右键的重复操作。
方法一：资源管理器多选后触发
① 在 VS Code 或 JetBrains 的项目资源树中，按住 Ctrl（Windows/Linux）或 Cmd（macOS） 键，逐一点击需处理的源码文件（支持 .py/.js/.ts/.jsx/.tsx 后缀）。
② 全部选中后右键 → 选择 【Add Documentation to Selected Files】。
③ 等待进度条走完，每个文件中所有可文档化的函数与类都会被注入标准注释——注意：已有注释的函数不会被覆盖，只补充缺失项。
方法二：通过 Craft 对话框指令驱动
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 问题
在左侧 Craft 面板输入：/comments，然后回车。系统会自动检测当前工作区中所有未注释的函数，并列出预览清单。确认无误后点击“全部应用”，注释将写入对应文件。
用自然语言描述驱动注释生成
当函数命名模糊（比如叫 handleData()）、逻辑嵌套深、或涉及业务专有名词时，纯靠代码静态分析容易误解意图。这时你得告诉 AI “你想让它怎么理解”。
1、把光标放在目标函数内部任意位置。
2、按下快捷键 Cmd+Shift+D（macOS）或 Ctrl+Shift+D（Windows/Linux），唤起语义引导对话框。
3、输入一句清晰的中文说明，例如：“根据订单ID查出主订单和所有子订单，合并收货人信息后返回扁平化列表，若子订单状态异常则跳过不合并”。
4、点击生成，AI 会优先依据你这句话组织注释内容，而不是死抠代码变量名——【这是唯一能绕过命名缺陷、确保注释业务准确性的方式】。
圈选局部逻辑块添加解释型注释
适用于调试阶段临时标注某段难懂的正则、算法步骤或状态机流转，不需要完整函数级文档，只要一行说清“这段在干啥”。
1、用鼠标拖选目标代码段（比如一个 for 循环体、一段 base64 解码逻辑、或一个 Redux reducer 的 case 分支）。
2、右键 → 选择 【腾讯云代码助手 > 解释代码】。
3、模型返回后，点击 【插入为注释】 按钮，注释将以 // 或 /* */ 形式紧贴选中代码上方插入。
这一步操作起来很简单，直接把文件拖进去就行。
