代码干净不等于清楚：注释不是失败，是路牌

行业里流行一句话：好代码不用注释，需要解释就是写砸了。作者说，我也喜欢这话，可我也喜欢路：再好的盘山道，弯道前也有牌子，不是因为修路的人失败，是因为你看不见弯。代码也一样：有些函数，这辈子解释不清自己，总有三种代码，注释必须在。这篇在海外拿下上百赞，评论区：牌子论，服气。

一、三种必须立牌子的代码。第一，祖传代码：当初就没奔着清楚写，没人懂，只能靠注释续命。第二，太难的代码：写得再漂亮，解的问题本身绕，盯五小时才懂的函数，不配个牌子，对不起后人。第三，动机藏着的代码：看着清清爽爽，可为啥这么写，代码里一个字没提，比如某串编号规则，不懂行的一猜就错。作者现场出了道小考：一串编号，四个候选，哪个合法，不懂行的全灭。有牌子，一分钟，没牌子，一小时。

二、最坏的不是没注释，是撒谎的注释。代码改了，注释没跟，牌子指错路，比没牌子更坑人，坑的还是信你的人。所以规矩是：要么不写，写了就养着，改代码必改注释，顺手的事。还有，注释写为啥，不写干啥：干啥看代码就行，为啥代码讲不清。动机、坑位、别碰的地方，这三样最值钱。评论区补了铁律：提交信息里写清为啥，牌子从提交时就开始立。

三、抄作业。今天翻你手里最熟的模块，找三个为啥没写的地方，补上。每处三行：为啥这么干，坑在哪，别碰啥。补完你会发现，三个月后回来谢自己的人，就是自己。干净是给机器看的，清楚是给人看的，代码终归是人看的。