别再手动写代码注释了!AI 自动生成神器
提示词描述:
AI 自动生成代码注释工具,支持多种编程语言和注释风格。从简洁版到教学版,满足不同场景需求。帮你节省 90% 的注释时间,让代码更规范、更易维护。
提示语关键词:
AI 代码注释,自动写注释,ChatGPT 编程助手,代码文档生成,编程效率工具,代码规范
提示词内容:
【痛点切入】
写代码 5 分钟,写注释 2 小时?是时候让 AI 帮你搞定这个烦人的活儿了!
【模板说明】
这个提示词能让 AI 自动为你的代码生成专业、清晰的注释,支持多种编程语言。
【使用场景】
🎯 需要提交代码但没时间写注释
🎯 接手别人的代码看不懂逻辑
🎯 想让代码更规范、更易维护
🎯 准备代码审查或项目交接
【模板正文】
请为以下{编程语言}代码添加详细注释:
```
{粘贴你的代码}
```
要求:
1. 注释风格:{简洁版/详细版/教学版}
2. 包含内容:
- 文件/函数整体功能说明
- 关键逻辑的解释
- 复杂算法的思路说明
- 重要参数的含义
- 可能的优化建议(可选)
3. 注释格式:{单行注释/多行注释/文档注释}
4. 语言:{中文/英文}
【填写指南】
1. 代码要完整,避免片段导致理解偏差
2. 注释风格选择:
- 简洁版:适合熟练开发者,点到为止
- 详细版:适合团队协作,解释充分
- 教学版:适合学习分享,通俗易懂
3. 特殊需求可以追加:
- "请标注潜在的 bug"
- "请说明时间复杂度"
- "请给出重构建议"
【效果示例】
输入代码:
```python
def fib(n):
if n <= 1:
return n
return fib(n-1) + fib(n-2)
```
AI 生成(详细版):
```python
def fib(n):
"""
计算斐波那契数列第 n 项
参数:
n (int): 数列位置,从 0 开始
返回:
int: 第 n 项的值
说明:
使用递归实现,时间复杂度 O(2^n)
对于较大的 n 值,建议使用动态规划优化
"""
# 基础情况:第 0 项和第 1 项都是自身
if n <= 1:
return n
# 递归计算:当前项 = 前两项之和
return fib(n-1) + fib(n-2)
```
【对比分析】
不同注释风格对比:
简洁版:
```
// 计算斐波那契数
```
详细版:
```
/**
* 使用递归计算斐波那契数列
* 注意:大数值时性能较差
*/
```
教学版:
```
// 斐波那契数列:每个数等于前两个数之和
// 例如:0, 1, 1, 2, 3, 5, 8...
// 这里用递归实现,虽然简洁但效率不高
```
【进阶用法】
可以批量处理:
"请为这个文件中的所有函数添加注释,保持风格统一"
可以生成文档:
"请基于这些注释生成 API 文档"
---
⚡ 效率提升:原来 2 小时的注释工作,现在 5 分钟搞定!