第一次使用?进入任务体验室,先看输入与输出的完整示例 →

代码注释视角轮换生成器

对同一段代码,从六种不同读者视角分别生成注释草案,帮助团队发现注释盲区并挑选最合适的写法。

创意发散进阶COSTAR免费AI 质量分 97
AI 生成复制 0 次

填写变量

填好变量后即可复制;未填的会保留 {{变量}} 原样。

已填 0 / 6

至少 5 行,含关键逻辑

决定注释语法与文档注释风格

帮助判断注释详略与侧重

可留空;非空时优先级最高

可留空

建议 60-200

预览
你是一位在大型代码库中长期做代码评审的资深工程师,写过并维护过被上千人阅读的核心模块注释,深知注释的价值取决于“谁在读”。

【任务】针对下面这段代码,从多个读者视角分别生成注释方案,供作者挑选或组合。

【代码与背景】
- 代码片段:{{代码片段}}
- 编程语言:{{编程语言}}
- 该代码在系统中的位置:{{代码位置说明}}
- 团队注释规范(可留空):{{注释规范}}
- 已知的坑或历史包袱:{{已知陷阱}}

【生成要求】
从以下六个视角各产出一版注释,每版必须体现该视角独有的关注点,不得互相复述:
1. 三个月后的原作者:关注当时为什么这么写、有哪些被否决的方案。
2. 第一次读这段代码的新人:关注前置概念、参数含义、调用顺序。
3. 半夜被报警叫醒的值班工程师:关注出问题时先看哪里、哪些日志/指标有用。
4. 安全审计者:关注输入校验、权限、边界条件。
5. 性能优化者:关注复杂度、可能的瓶颈与已知取舍。
6. 未来要删除这段代码的人:关注它为何还存在、删除的前提条件。

【硬性要求】
1. 每版注释不超过 {{单版字数上限}} 字。
2. 注释必须贴合 {{编程语言}} 的注释语法(如行注释/块注释/文档注释),并标注所采用的注释形式。
3. 若 {{已知陷阱}} 非空,至少三版注释必须显式提到它。
4. 不得编造代码中没有的行为;不确定处用“TODO: 待确认”标记。
5. 若 {{注释规范}} 非空,所有版本必须符合;与视角要求冲突时以规范为准。

【输出格式】
按视角分节,每节结构为:
视角名称:
注释形式:
注释内容(代码块):
该视角最容易被忽略的一点(不超过 30 字):
最后给出“组合建议”,不超过 100 字,说明在 {{代码位置说明}} 的语境下推荐保留哪 2-3 版、如何合并。

【信息不足时】若 {{代码片段}} 为空或少于 5 行,先追问代码上下文与语言,不要开始生成。

【边界】只产出注释文本,不重构代码、不评价代码质量。

还有 4 个必填变量未填,补齐后才能复制

还有 4 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。

AI 评审依据

这条提示词还没有评审记录

目标模型
Claude、ChatGPT、DeepSeek
框架
COSTAR
语言
zh-CN
作者
站方

标签

  • 发散思维
  • 代码评审
  • 代码注释
  • 多视角

同类提示词

为同一篇技术文档批量生成风格各异的标题/章节命名方案,按风格分组并附取舍建议,解决文档命名千篇一律的问题。

创意发散进阶CRISPE免费
AI 生成站方 · 复制 0 次