Codex/GPT 提示词怎么让它多写注释

codex感觉很不喜欢写注释,我都这么写系统提示词了,它还是很多逻辑和变量不写注释,导致我人工去review的时候还挺费劲。

  • 代码注释密度底线:应保持至少 1:5 的注释与代码行比例,即平均每 5 行代码至少出现一行有意义的代码行上方的中文注释。

佬友们有没有什么好的模板提示词。

补充一下,一般写java,少量的vue

同蹲一个方案,我这边让加注释也很多不加,Gemini 的话就特别全

你在agent.md上加rule就行吧?你是在哪加的?

写前端的时候 gpt就特别喜欢写注释 一写写一大堆

同求这个问题,我自己人工加的注释,它还会把我的注释给去掉,无语了。


我这么写,它就不会删我的注释了。不过如果你是在两轮对话中间插入的注释,它可能没有重新读文件导致不知道你写注释了吧。

说下我的想法,写太多注释其实是没有意义的,代码本身就是注释,只有缺少业务背景或者实现有一些workaround需要交代的时候,才建议写

但是review或者以后修复bug的时候,缺少注释很头疼,特别代码还不是自己写的。

最后肯定还让 Codex 来 review 呀 :laughing:

我在项目文件的AGENT.md加了注释规则,在全局的AGENT.md加了注释规则,在全局的rules文件夹下也新建了注释规则,就是不爱写,每次让他写完一个功能就得额外让他梳理一下代码,补充一下注释,太头疼了,而且老喜欢抽函数,不复杂的传参也抽一个buildPayload,编辑回显也抽一个normalize…,我review的时候跳来跳去看的迷迷糊糊的 :distorted_face:

在AGENT.md加了一段提示词,完全没有违反的情况,写的代码全加注释了

注释原则(非常重要)

  • 应当给类的所有成员添加和公有方法同等级的注释,并且在编码时需要一并添加注释,而不是仅编码。

有一说一,是AGENTS.md,不知道你是这里打错了还是文件名写错了 :joy:
buildPayload在codex确实太经典了

claude 就相反,什么小事都写注释。

gpt现在的问题就是写的代码 人工看不懂

打错了orz,老是不分,全局是文件本来就有的直接在里面加规则,项目下是让他自己生成的,有没有s经常弄混 :joy:

这个应该是娘胎带出来的习惯,最好的方式是在对话中让他添加
不过纯AI生成的话,量太大了,完全不适合人工review

全局AGENTS.md增加:

#### 注释规范

- **文档代码化**:设计文档中的业务规则、状态流转、异常分支等内容,必须映射到具体实现代码附近。  
  例如:223-230 行实现“审批通过后自动生成出库单”,则应在对应代码段前增加该业务说明。
- **注释贴近实现**:注释应尽量靠近实际业务代码,优先描述“这段代码在处理什么业务”,不是重复翻译代码,避免出现代码与注释位置割裂的问题。
- **禁止空泛注释**:禁止使用“这里进行校验”“处理数据”等无业务含义的描述,注释需要明确说明校验对象、触发条件、业务目的及影响结果。
- **用词自然业务化**:注释中禁止出现“需求要求”“设计要求”“根据文档”等机械化表述,应直接以业务视角描述实际逻辑。
- **避免注释堆积**:禁止在类头或方法头一次性堆砌大段业务说明,业务注释应按逻辑分段,映射到对应代码区域。
- **保持注释与代码同步**:修改业务逻辑时必须同步更新对应注释,禁止出现注释与实际行为不一致的情况。