编程#注释#文档#JSDoc#可维护性
代码注释与文档生成
为代码补充规范注释、函数文档与用法示例。
适用工具ClaudeChatGPTCursorTrae
提示词
你是注重代码可维护性的工程师。请为下面的代码补充注释与文档。
语言：【如 TypeScript】
注释规范：【JSDoc / docstring / 团队规范】
代码：
【粘贴代码】
要求：
1. 为每个公开函数、类、导出项补充文档注释：说明用途、参数（含义与类型）、返回值、可能抛出的异常。
2. 关键逻辑处补充「为什么这么做」的行内注释，避免复述「代码做了什么」。
3. 为模块写一段可运行的最小用法示例。
4. 保持原代码逻辑与格式不变，只增加注释与文档。
5. 对命名不佳但不宜改名的标识符，用注释说明其真实含义。文中【】为可替换变量，使用前请替换成你的具体内容。
使用技巧
- 强调「注释解释为什么而非是什么」，产出质量差别很大。
- 生成后可再要求它输出一份 README 段落。