一个临时补丁的注释,可能让后续的AI Agent连续写错好几版代码。Viking在推文里点出了这个容易被忽略的细节:Agent很喜欢复制已有代码和注释,一个无害的workaround注释,会影响之后Agent的代码生成,滚雪球一样越来越多。
问题不在注释本身,而在注释的质量。过时的临时修复、重复的代码描述、无关的TODO条目,这些内容会随着时间累积。它们被后续的AI Agent当成重要上下文读取,然后被复制、被引用,最终让代码库越来越难维护。
![]()
哪些注释该留,哪些该删
Viking给出的判断标准很直接:不是所有注释都要清理。宏观架构图、公共API规范、重要的浏览器兼容说明,这些有实质价值的注释应该保留。真正该淘汰的是另一类——
- 重复代码本身在做什么的描述
- 已经过时的临时修复说明
- 与当前任务无关的TODO条目
- 微观层面的"工作思路"记录
这些注释的共同点是:它们记录的是某个时刻的临时状态,而不是代码长期需要的信息。当AI Agent把它们当作有效上下文时,错误就被继承下去了。
一个叫/no-comment的工具
针对这个问题,Viking提到了一个名为/no-comment的skill。它的作用是扫描代码库,帮助开发者识别并删除那些低价值或有害的注释,同时保留真正有价值的部分。
这个工具解决的是清理环节的效率问题。人工判断哪些注释该删,在大型代码库里成本很高,而且容易漏。自动化扫描能把这类"病毒"注释先筛出来,再由开发者决定去留。
对正在用AI Agent辅助编程的团队来说,这件事的优先级可能比想象中高。注释是喂给Agent的上下文的一部分,上下文里混进过时或错误的信息,Agent的输出质量就会跟着下降。清理注释不只是代码整洁问题,也是让Agent少犯错的前置动作。
特别声明:以上内容(如有图片或视频亦包括在内)为自媒体平台“网易号”用户上传并发布,本平台仅提供信息存储服务。
Notice: The content above (including the pictures and videos if any) is uploaded and posted by a user of NetEase Hao, which is a social media platform and only provides information storage services.