codebuddy支持五种接口生成方式:一、自然语言注释触发;二、对象字面量类型推导;三、jsdoc @typedef 转换;四、无类型函数反向标注;五、结构化提示词生成高级类型。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您在开发 TypeScript 项目时需要快速生成接口定义文件(如 interface、type alias 等),但手动编写易出错且效率低下,则 CodeBuddy 可通过多种上下文感知方式自动生成符合语义与结构的类型定义代码。以下是实现该目标的多种方法:
一、使用自然语言注释触发接口生成
该方法利用 CodeBuddy 对中文或英文注释的语义理解能力,在不改动现有代码的前提下,预先声明类型契约,适用于函数定义前、模块设计初期等场景。
1、在 .ts 文件中新建一行,输入类似 // 定义订单详情接口,包含 id(字符串)、amount(数字)、status(枚举值:pending/shipped/completed)、items(商品数组) 的注释。
2、将光标置于该行末尾,按下 Ctrl+Enter 触发补全,或等待自动补全弹出(若已启用 autoTrigger)。
3、从建议列表中选择匹配度最高的 interface OrderDetail 选项,按 Tab 或 Enter 插入生成代码。
二、选中对象字面量后请求类型推导
当已有运行时数据结构(如 mock 数据、API 响应示例、配置对象)时,CodeBuddy 可基于键名、值类型、嵌套层级及 null/undefined 情况,反向推导出精准的 TypeScript 接口定义,避免人工映射偏差。
1、在 .ts 文件中写入一个对象字面量,例如:const orderResponse = { id: "ORD-001", amount: 299.99, status: "shipped", items: [{ sku: "A123", qty: 2 }] };
2、用鼠标选中从 const orderResponse = 开始至右大括号结束的整段代码。
3、右键选择 “Ask CodeBuddy”(或使用快捷键 Ctrl+Shift+P → 输入 “CodeBuddy: Ask”)。
4、在弹出输入框中键入 “为上述对象生成 TypeScript interface,命名为 OrderResponse,要求 items 字段类型为 Item[]”,回车确认。
三、通过 JSDoc @typedef 标签声明类型需求
该方式兼容 JavaScript 与 TypeScript 项目,允许在已有函数或变量上方添加结构化注释,显式指示 CodeBuddy 应生成何种类型定义,适合渐进式类型迁移场景。
1、在函数上方添加 JSDoc 块,例如:/**\n * @typedef {Object} PaymentConfig\n * @property {string} gateway - 支付网关标识\n * @property {number} timeout - 超时毫秒数\n * @property {boolean} [retryOnFailure=false] - 是否失败重试\n */
2、将光标置于 @typedef 行任意位置。
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 问题
3、按下 Alt+Enter(或右键选择 “Generate TypeScript Type from JSDoc”)。
4、CodeBuddy 自动将 JSDoc 转换为标准 TypeScript interface PaymentConfig 并插入到光标所在位置。
四、为无类型函数反向添加参数与返回值类型
针对已存在但未标注类型的 JavaScript 函数或 TS 中 any 类型函数,CodeBuddy 可分析其内部逻辑、参数使用方式及 return 表达式,生成带完整签名的类型化版本,提升类型安全性与可维护性。
1、定位一个无类型函数,例如:function processOrder(data) { return { result: true, code: data.id ? 200 : 400 }; }
2、将光标置于 function 关键字上。
3、按下 Ctrl+Shift+T(CodeBuddy 类型增强快捷键)。
4、CodeBuddy 分析 data 参数被访问的属性(id),以及返回对象结构,生成:function processOrder(data: { id?: string }): { result: boolean; code: number }。
五、使用结构化提示词生成高级类型定义
该方法适用于需生成泛型、条件类型、映射类型等复杂 TypeScript 类型的场景,通过明确语法关键词引导 CodeBuddy 输出符合 TypeScript 高级类型规范的代码。
1、在空行输入提示词:// 生成一个泛型接口 ApiResponse
2、将光标置于该行末尾,触发 CodeBuddy 补全(Ctrl+Enter)。
3、选择建议项,插入生成结果:interface ApiResponse
4、如需进一步生成具体实例类型,可在下一行输入:// 基于 ApiResponse 生成 UserResponse 类型,其中 T 为 { id: string; name: string },再次触发补全。










