别再让编程助手写冗长的注释了
本文讨论了一个常见问题：AI编程助手在生成代码时倾向于添加过多、过于详细的注释，导致代码可读性反而下降。作者提出了一种简单有效的解决方案——通过为AI设定明确的注释风格指南，要求注释简洁、仅在必要时出现，从而让生成的代码更加清晰易读。文章提供了具体的提示词示例和对比效果，展示了如何在不牺牲代码质量的前提下，大幅减少不必要的注释噪音。
背景速读
- 当前 AI 编码代理（如 Cursor、Copilot、Claude 等）在生成代码时，常常会写出冗长且无必要的注释，例如逐行解释显而易见的逻辑、重复函数名、或者加上“// This function does X”之类的废话。这种现象在开发者社区中被称为“prolix comments”（冗长注释），引发了广泛吐槽。
- 本文作者 Danver Imbue 发布了一个名为 **crispy-comments** 的开源工具，旨在自动检测并移除这些 AI 生成的啰嗦注释。它的核心思路是：注释不应重复代码已经说清楚的事，而应解释“为什么这么做”或“隐藏的上下文”。
- 该项目提供 ESLint 插件和 CLI 工具，可集成到现有开发工作流中，帮助团队在代码审查前清理无效注释。背后的讨论触及了一个更大的问题：LLM 生成代码的“废话倾向”如何降低代码可读性，以及人类开发者是否需要主动对抗这种习惯。