💻 编程开发适用:ChatGPT, Claude, Cursor, GitHub Copilot
代码注释生成
为代码自动生成规范化中文注释和 API 使用文档
注释文档代码质量
提示词内容
请为以下代码自动生成中文注释和文档。
代码:
```
{粘贴需要添加注释的代码}
```
编程语言:{语言}
注释风格:{JSDoc / Javadoc / Docstring / 行内注释}
详细程度:{简洁 / 标准 / 详细}
请提供:
1. 添加注释后的完整代码
- 文件/模块头部注释(功能说明、作者、版本)
- 函数/方法注释(功能描述、参数说明、返回值、异常)
- 复杂逻辑的行内注释
- 类/接口注释
2. 注释规范说明
- 使用的注释格式规范
3. 使用文档
- 核心 API 的调用示例
- 安装/配置说明(如适用)
要求:
- 注释清晰易懂,不重复代码本身
- 说明"为什么"而非"是什么"
- 标记 TODO 和待优化点
- 保持代码原有逻辑不变使用技巧
建议分文件处理,每次提交一个模块的注释变更,便于 code review
使用场景示例
适用于需要为项目补充文档、维护老旧代码或生成 API 接口文档的开发场景