函数生成模式
从签名 + 文档 + 示例生成函数;用类型与测试门控。
代码生成入门
为什么
GitHub 2024 Octoverse 报告显示生成式 AI 项目贡献量激增 59%,平台 AI 项目总数增长 98%。签名 + 文档 + 示例完整指定大多数函数。
从该规格生成体产生匹配你类型与意图的代码,并有测试证明。
何时使用
任何有清晰签名的纯或近纯函数用此。UI/有状态代码跳过。
如何做
1. 写签名 + JSDoc 含 @param/@returns 与示例。
2. 提示:"按文档实现;处理这些边界:..."。
3. 同时要测试(正常路径 + 各边界)。
4. 跑 tsc + 测试;红则迭代。
5. 拒绝任何签名变更除非你批准。
示例
/**
* 将 page 查询参数解析为 1 起页码。
* @param input - 来自 ?page= 的原始字符串
* @returns 1 起页(最小 1),无效则 1
* @example parsePage("3") // 3
*/
export const parsePage = (input: string | null): number => { ... }
提示:"按文档实现;边界:null、''、'0'、'-1'、'abc'、'999'"
常见问题
- ⚠生成代码编译失败:"SyntaxError: Unexpected token" → 要求模型输出含正确 import 的完整文件;用 `npx tsc --noEmit` 验证。
- ⚠错误:幻觉 API:模型调用不存在的函数 → 对照真实库文档检查并在 package.json 锁定版本。
- ⚠Error: Cannot find module 'xxx' → `npm install xxx`;生成代码常导入项目尚未安装的包。
最佳实践
- ✓体前指定签名与示例。
- ✓同轮生成测试趁上下文新鲜。
- ✓用具体指标衡量结果(节省时间、缺陷率、测试覆盖率),使实践可被论证和改进。
常见问题解答
什么是函数生成模式?
从签名 + 文档 + 示例生成函数;用类型与测试门控。 它可帮助开发者快速理解 函数生成模式 的核心价值与适用场景。
如何开始使用函数生成模式?
开始使用 函数生成模式,建议先掌握以下要点:写签名 + JSDoc 含 @param/@returns 与示例。
函数生成模式 的常见误区有哪些?
使用 函数生成模式 时常遇到的问题包括:生成代码编译失败:"SyntaxError: Unexpected token" → 要求模型输出含正确 import 的完整文件;用 `npx tsc --noEmit` 验证。;错误:幻觉 API:模型调用不存在的函数 → 对照真实库文档检查并在 package.json 锁定版本。;Error: Cannot find module 'xxx' → `npm install xxx`;生成代码常导入项目尚未安装的包。。
函数生成模式 的最佳实践是什么?
函数生成模式 的最佳实践包括:体前指定签名与示例。;同轮生成测试趁上下文新鲜。;用具体指标衡量结果(节省时间、缺陷率、测试覆盖率),使实践可被论证和改进。。
如何深入学习函数生成模式?
从官方文档入手,再在 GitHub 上搜索真实示例;先在小实验仓库验证模式,再应用到生产代码。