代碼乾淨不等於清楚：註釋不是失敗，是路牌

行業裏流行一句話：好代碼不用註釋，需要解釋就是寫砸了。作者說，我也喜歡這話，可我也喜歡路：再好的盤山道，彎道前也有牌子，不是因爲修路的人失敗，是因爲你看不見彎。代碼也一樣：有些函數，這輩子解釋不清自己，總有三種代碼，註釋必須在。這篇在海外拿下上百贊，評論區：牌子論，服氣。

一、三種必須立牌子的代碼。第一，祖傳代碼：當初就沒奔着清楚寫，沒人懂，只能靠註釋續命。第二，太難的代碼：寫得再漂亮，解的問題本身繞，盯五小時才懂的函數，不配個牌子，對不起後人。第三，動機藏着的代碼：看着清清爽爽，可爲啥這麼寫，代碼裏一個字沒提，比如某串編號規則，不懂行的一猜就錯。作者現場出了道小考：一串編號，四個候選，哪個合法，不懂行的全滅。有牌子，一分鐘，沒牌子，一小時。

二、最壞的不是沒註釋，是撒謊的註釋。代碼改了，註釋沒跟，牌子指錯路，比沒牌子更坑人，坑的還是信你的人。所以規矩是：要麼不寫，寫了就養着，改代碼必改註釋，順手的事。還有，註釋寫爲啥，不寫幹啥：幹啥看代碼就行，爲啥代碼講不清。動機、坑位、別碰的地方，這三樣最值錢。評論區補了鐵律：提交信息裏寫清爲啥，牌子從提交時就開始立。

三、抄作業。今天翻你手裏最熟的模塊，找三個爲啥沒寫的地方，補上。每處三行：爲啥這麼幹，坑在哪，別碰啥。補完你會發現，三個月後回來謝自己的人，就是自己。乾淨是給機器看的，清楚是給人看的，代碼終歸是人看的。

來源｜海外開發者社區，https://dev.to/georgekobaidze/clean-code-is-not-the-same-as-clear-code-comments-were-never-the-problem-42n