跳到正文
联系

说谎注释定律

编程与 BUG

当注释和代码意见不一致时,很可能两个都是错的。

— 佚名, 计算机民间传说
VIDEO.EXE16:9

注释是程序员留在代码里、解释代码在做什么的句子。理论上,这是对后来者的一份善意。实际上,它像一条已经改道的公路上留着的路牌。

代码改了,注释还在。于是你会在一个给经理发邮件的函数上面,读到“计算百分之十的折扣”。谁对?谁都不对。注释讲的是一个古老的意图,代码讲的是一场现代的事故。

还有一个相反的流派:骄傲的程序员从不写注释——写的时候很难,读的时候也得很难。我站在中间。我总是写注释,但写的是“别碰”这种话。它什么都没解释,却救了很多条命。