CodeBuddy可自动为Python/JavaScript项目生成符合PEP 257或JSDoc标准的结构化注释，支持函数级一键生成、多文件批量补全、局部代码解释及自然语言反向生成四种方式，全程不修改原有代码。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果你正在维护一个已有大量无注释的Python或JavaScript项目，手动补全函数级、类级甚至整文件的规范注释既耗时又容易遗漏关键逻辑点，CodeBuddy能基于语义理解自动插入符合PEP 257或JSDoc标准的结构化注释，且不改动任何一行原有代码。
函数级一键生成文档字符串
这一步适合刚写完但还没加注释的单个函数，AI会读取参数名、返回值类型和函数体逻辑，自动生成带:param、:return、:raises等字段的docstring。
1、在编辑器中将光标置于目标函数名所在行，或用鼠标完整选中该函数（含def/function关键字、参数列表与缩进后的第一行代码）。
2、右键 → 在弹出菜单中选择【Generate Doc】选项。
3、等待2–5秒，AI完成分析后，标准文档字符串会直接插入到函数顶部，格式为三重双引号包裹的多行字符串。
注意：若函数内含复杂条件分支或调用外部服务，AI可能无法准确推断所有异常路径，此时需人工补充:raises说明。
批量为多个文件补全注释
当项目里有十几个.py或.js文件长期缺乏注释，逐个处理效率极低，此方法可一次性扫描并为所有可文档化对象注入基础注释块。
方法一：资源管理器多选触发
① 在VS Code资源管理器中按住Ctrl键，点击选中需补注释的全部源码文件（如user_service.py、order_controller.js、utils.ts）；
② 右键 → 选择【Add Documentation to Selected Files】；
③ 系统将逐文件解析，只为函数、类、模块级对象添加注释，跳过变量、常量和纯表达式语句。
方法二：Craft对话框指令驱动
在Craft界面输入指令：/add-docs --files src/api/ --style jsdoc --include-private，回车执行。该命令会递归扫描src/api/目录下所有.js/.ts文件，强制为带_前缀的私有方法也生成注释。
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 问题
【必须确保项目根目录下存在package.json或pyproject.toml，否则CodeBuddy无法识别语言生态与依赖上下文】
圈选局部代码生成解释型注释
适用于临时调试、交接代码或阅读他人写的晦涩逻辑块，比如一段嵌套map+reduce+filter的链式调用，或一个状态机转换的核心switch分支。
1、用鼠标拖选目标代码段（最小粒度支持单行表达式，最大支持整个class定义）。
2、右键 → 【腾讯云代码助手 > 解释代码】。
3、模型返回解释后，点击“插入为注释”按钮，注释将以//或/* */形式紧贴选中代码上方插入。
这一步操作起来很简单，直接把文件拖进去就行。但要注意：如果选中区域包含语法错误（如括号不匹配、缺少分号），AI可能拒绝解析并报错，此时需先修复基础语法再尝试。
用自然语言描述反向生成精准注释
当函数命名模糊（如handleData()）、参数含义不直观（如flag: boolean）、或业务逻辑超出代码字面量所能体现的范围时，该方式能让AI优先遵循你的中文意图，而非仅依赖符号推断。
第一步：将光标置于待注释函数内部任意位置（不必选中）。
第二步：按下快捷键Ctrl+Shift+D（Windows/Linux）或Cmd+Shift+D（macOS）。
第三步：在弹出框中用中文写清楚真实用途，例如：“根据用户设备指纹和IP地址判断是否为高风险登录，命中规则时返回{riskLevel: 'high', reason: '异地频繁切换'}”。
第四步：点击生成，AI会覆盖默认推断结果，输出完全匹配你描述的注释内容，并自动适配当前语言的注释风格。
这一步的关键在于描述必须包含输入来源、判断依据、输出结构三个要素，缺一不可，否则生成的注释仍会偏向代码字面量。
