注释

前言

什么也比不上放置良好的注释来的有用。什么也不会比乱七八糟的注释更有本事搞乱一个模块。什么也不会比陈旧、提供错误信息的注释更有破坏性。

1、注释不能美化糟糕的代码

带有少量注释的整洁而富有表达力的代码,要比带有大量注释的零碎而复杂的代码好的多。

2、用代码来阐述

3、好的注释

3.1、法律信息

3.2、提供信息的注释

比如:在接口或者抽象方法中提供基本信息,但是也要做到见方法名能知其意思。

3.3、对意图的解释

注释不但能提供有关实现的有用信息,而且还提供了摸个决定后面的意图。

3.4、阐释

如果对一段代码你不能修改,在其代码上加注释也会加深理解。

3.5、警示

方便给其他程序员看的;

如:在执行一个测试方法特别耗时,最好加上注释。

3.6、TODO注释

放置要做的工作;需要进一步优化的代码;

3.7、放大

注释可以用来放大某种看来不合理之物的重要性。

3.8、公共API中的Javadoc

对于公共的API,如JDK的手册;

4.4、坏注释

4.1、喃喃自语

4.2、多余的注释

4.3、误导性注释

4.4、循规式注释

4.5、日志式注释

4.6、废话注释

4.7、可怕的废话

4.8、能用函数就别用注释

4.9、位置标记

4.10、括号后面的注释

缩短函数

4.11、归属与署名

版本控制是最好的归属地

4.12、注释掉的代码

个人理解:对于还需要用到的代码加上注释;如果不再使用最好删掉;版本管理工具可以找到。

4.13、HTML的注释

4.14、非本地信息

4.15、信息过多

4.16、不明显的注释

4.17、函数头

4.18、非公共方法中的Javadoc


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容