前言
什么也比不上放置良好的注釋來的有用侈咕。什么也不會(huì)比亂七八糟的注釋更有本事搞亂一個(gè)模塊孵睬。什么也不會(huì)比陳舊石窑、提供錯(cuò)誤信息的注釋更有破壞性牌芋。
1、注釋不能美化糟糕的代碼
帶有少量注釋的整潔而富有表達(dá)力的代碼松逊，要比帶有大量注釋的零碎而復(fù)雜的代碼好的多。
2肯夏、用代碼來闡述
3经宏、好的注釋
3.1、法律信息
3.2驯击、提供信息的注釋
比如：在接口或者抽象方法中提供基本信息烁兰，但是也要做到見方法名能知其意思。
3.3徊都、對意圖的解釋
注釋不但能提供有關(guān)實(shí)現(xiàn)的有用信息沪斟，而且還提供了摸個(gè)決定后面的意圖。
3.4暇矫、闡釋
如果對一段代碼你不能修改主之，在其代碼上加注釋也會(huì)加深理解。
3.5李根、警示
方便給其他程序員看的槽奕；
如：在執(zhí)行一個(gè)測試方法特別耗時(shí)，最好加上注釋房轿。
3.6粤攒、TODO注釋
放置要做的工作；需要進(jìn)一步優(yōu)化的代碼囱持；
3.7夯接、放大
注釋可以用來放大某種看來不合理之物的重要性。
3.8纷妆、公共API中的Javadoc
對于公共的API盔几，如JDK的手冊；
4.4凭需、壞注釋
4.1问欠、喃喃自語
4.2肝匆、多余的注釋
4.3、誤導(dǎo)性注釋
4.4顺献、循規(guī)式注釋
4.5旗国、日志式注釋
4.6、廢話注釋
4.7注整、可怕的廢話
4.8能曾、能用函數(shù)就別用注釋
4.9、位置標(biāo)記
4.10肿轨、括號后面的注釋
縮短函數(shù)
4.11寿冕、歸屬與署名
版本控制是最好的歸屬地
4.12、注釋掉的代碼
個(gè)人理解：對于還需要用到的代碼加上注釋椒袍；如果不再使用最好刪掉驼唱；版本管理工具可以找到。
