注釋
"別給糟糕的代碼加注釋----重新寫吧"
若編程語言足夠有表達力，或者我們長于用這些語言來表達意圖组底，就不那么需要注釋--也許根本不需要
4.1 注釋不能美化糟糕的代碼
寫注釋的常見動機之一是糟糕的代碼存在花颗。
4.2 用代碼來闡述
4.3 好注釋
唯一 真正好的注釋是你想辦法不去寫的注釋
4.3.1 法律信息
4.3.2 提供信息的注釋
4.3.3 對意圖的解釋
4.3.4 闡釋
注釋把某些晦澀難明的參數(shù)或返回值的意義翻譯為某種可讀形式
4.3.5 警示
定期刪除沒有的TODO
4.3.7 放大
注釋可以用來放大某種看來不合理之物的重要性
4.3.8 公共API中的doc
4.4 壞注釋
壞注釋都是糟糕的代碼的支撐或接口捕传，或者對錯誤決策的修正
4.4.1 喃喃自語
4.4.2 多余的注釋
4.4.3 誤導(dǎo)性注釋
4.4.4 循環(huán)式注釋
4.4.5 日志式注釋
4.4.6 廢話注釋
4.4.7 可怕的廢話
4.4.8 能用函數(shù)或不變量時就別用注釋
4.4.9 位置標記
4.4.10 括號后面的注釋
4.4.11 歸屬與署名
4.4.12 注釋掉的代碼
4.4.13 HTML注釋
4.4.14 非本地信息
4.4.15 信息過多
4.4.16 不明顯的聯(lián)系
4.4.17 函數(shù)頭
4.4.18 非公共代碼中的javadoc
4.4.19 范例
