在github的LTP項目(一個linux核心測試項目)的文檔看到這麼一句話不很了解，關于代碼注釋的危害.
我印象中不是鼓勵大家進行代碼注釋嘛？這裡面說Comments more harm than good 。
原因 ：comments and actual implementation were drifting slowly apart
結果：API misuses and hard to find bugs.
通俗的講，就是如果你給了錯誤注釋，注釋的内容與實際代碼所做的内容相差甚遠，會誤導到其他使用到這段代碼的人。
錯誤的文檔往往比沒有文檔跟糟糕，因為這會把使用者引向錯誤的導向。
1000道程式員常見問題解析是最近新整理的一個專欄，歡迎大家提供問題與思路。
所有問題、思路、答案将整理在公衆号，大家可以掃碼關注一下，互相交流學習。
關注即可免費領取一份2020技術學習提升大禮包！（含文檔、電子書、視訊等等）