一个实例:为什么注释是愚蠢的
这篇文章讲的是代码注释在软件开发中的争议与价值。作者从自己早年认为“写注释是好习惯”出发,经过研读《代码大全》与《代码整洁之道》,观点发生了根本转变:冗余或解释性的注释往往掩盖了代码本身命名不佳、结构混乱的问题。 为了证明这一点,作者没有虚构例子,而是选取了微软开源的 .NET 框架中一个真实的路径分割方法进行重构演示。他一步步展示了如何通过将参数名 `path` 重命名为 `validatedFullPath` 来消除“假设路径已验证”的注释,以及如何通过提取方法、引入类结构等方式,将原本需要多条注释来解释的逻辑,转化为自解释的代码结构。 文章的核心论点是,真正优秀的代码应当像清晰的散文一样“会沟通”,程序员的精力应该投入到打磨可读性高的命名和结构上,而不是用注释来弥补代码的缺陷。它并非全盘否定注释,而是倡导一种更根本的编码哲学:追求代码本身的清晰,应是专业开发者的目标。