Clean Code(三)：註釋

在工做中常常在剛開始寫代碼的時候，寫下類與方法的註釋，時間久了，CR多了，也不可能一直去修改註釋了。加班都累成dog。註釋纔不改呢，就是這麼任性，哈哈。

項目久了，註釋會欺騙閱讀者，本人被騙過，也騙過別人。

註釋只是一種代碼的補充，若是方法，類，變量命名好的話，通常不須要註釋，它並不能美化代碼，醜陋的代碼通過N次CR以後，除了開發者無人能懂，註釋就變成了毒藥。

通常下列註釋仍是能夠的：

法律信息：只要有可能，就指向一份標準許可或其餘外部文檔，而不是把全部條款放到註釋中

提供信息的註釋：好比某個抽象方法的返回值，某個map參數中的鍵值

對意圖的解釋：就是爲何要這麼作，對下面的代碼帶來了什麼樣的影響

闡釋：把某種難明的參數或返回值，翻譯爲可讀的形式

警示的註釋

公共的API，這個我以爲必定要有。