一、良好注释
丰富的注释和良好的代码规范,对于代码的阅读性和可维护性起着至关重要的作用。几乎每个公司对这的要求还是比较严格的,往往会形成自己的一套编码规范。但是在实施过程中,如果全靠手动完成,不仅效率低下,还难以保证真正的符合规范。所以结合IDE环境,自动生成注释,还是很有必要的。本文章介绍使用Eclipse来创建自定义代码注释模板。
二、良好注释需要遵循的规则
- 好的注释就是没有注释,
让代码具有自解释
功能。 注释要精炼
,不要废话连篇,不要太长,不要单纯的重复。提供信息
的注释是好注释。有的注释只是把代码翻译一下,没有指出代码的目的等有用信息。TODO注释也是好注释
,用以提醒程序员代码的某些部分未完成。- 对于
公共的API需要提供好的Javadoc
。 不要注释代码
。注释掉的代码会给后面的人一种很重要的感觉,别人不会删除,到最后会产生大量的令人厌恶的包含注释的代码。不要万物皆注释
。- 写了注释之后要
时常更新
。
三、设置注释模板
eclipse:Window->Preference->Java->Code Style->Code Template
下面安利几个地方,添加注释后比较舒适。
(1)Types注释标签(类的注释)
/**
* 类说明:
*
* @guoqianliang1998.
*/
(2)Method注释标签(方法的注释)
/**
* 方法说明:
*
*/