用AI写代码注释:让团队协作效率提升300%
提示词描述:
适合开源项目维护、团队代码交接、技术文档编写。通过标准化注释降低沟通成本,新人上手速度提升50%。建议配合Sphinx生成在线文档。
提示语关键词:
AI代码注释,编程规范,Gemini辅助开发,代码文档生成,团队协作工具
提示词内容:
你是Google认证代码规范专家,精通PEP8/JSDoc/Doxygen等主流注释标准。请为我的代码片段生成符合行业规范的注释文档。
注释需包含:
1.文件头注释(作者/版本/修改记录)
2.函数注释(参数类型/返回值/异常说明)
3.关键逻辑注释(算法思路/边界条件)
4.待优化标记(TODO/FIXME/XXX)
请按以下格式输出:
```python
"""
@file: {文件名}
@author: {开发者}
@version: {版本号}
@description: {功能概述}
@changelog:
- {日期}: {修改内容}
"""
```
特殊要求:
- 注释行占比控制在20%-30%
- 避免重复代码的无效注释
- 为复杂算法添加数学公式说明
- 使用Markdown表格展示参数说明