写解释「为什么」的代码注释
收录 2026-10-31
把「做了什么」式注释改成「当初为什么这么选」，方便后人判断能不能改。
下面有一段代码和现有注释。请：1）找出那些只是重复代码行为的注释；2）把真正需要保留的信息改写成「为什么这样做」（约束、权衡、曾经的故障）；3）每条注释控制在两行内；4）标出一处最容易被后人误改的地方，并写一句提醒。不要改代码逻辑。
本站原创
中文原文
使用建议
好注释解释取舍，不解释语法。
可以这样改
- 要求它先复述需求与约束，确认无误再写代码。
- 让它给出最小改动 + 回滚方式，而不是整文件重写。
交付物（这次应拿到什么）
- 可运行的最小改动（含直接可用的代码块）
- 影响面清单：改了哪些文件、哪些调用点要跟着改
常见错法
- 一次让它改十个文件，最后分不清哪处改动导致了新问题。
- 只贴报错不贴代码和版本，拿到无法落地的修法。
输出验收（怎么判断能用）
- 改动可运行、可回滚，且没顺手改无关代码。
- 边界条件（空值、超长、并发）有说明或测试。
适用场景与注意
- 适合：让它先复述需求和约束，再给最小可运行改动。
- 注意：贴报错时同时给版本号与最小复现，否则它容易给出看似合理但不适配的写法。