在工作中經(jīng)常在剛開始寫代碼的時候，寫下類與方法的注釋，時間久了，CR多了，也不可能一直去修改注釋了。加班都累成dog。注釋才不改呢，就是這么任性，哈哈。

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

注釋只是一種代碼的補充，如果方法，類，變量命名好的話，一般不需要注釋，它并不能美化代碼，丑陋的代碼經(jīng)過N次CR之后，除了開發(fā)者無人能懂，注釋就變成了毒藥。

一般下列注釋還是可以的：

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

提供信息的注釋：比如某個抽象方法的返回值，某個map參數(shù)中的鍵值

對意圖的解釋：就是為什么要這么做，對下面的代碼帶來了什么樣的影響

闡釋：把某種難明的參數(shù)或返回值，翻譯為可讀的形式

警示的注釋

公共的API，這個我覺得一定要有。