码迷,mamicode.com
首页 > 其他好文 > 详细

代码整洁

时间:2015-09-22 13:08:56      阅读:203      评论:0      收藏:0      [点我收藏+]

标签:

1、类名:类名和对象应该是名词或名词短语,如Customer、WikiPage、Account等等。避免使用Manager、Processor这样的类名。

2、方法名:方法名应当是动词或者动词短语,如postPayment、save、delete等等属性访问器、修改器和断言应该根据其值命名,并依据Javabean标准加上get、set、和is前缀。

3、常量:避免出现 a==1。1为常量,需要用宏定义来代替  private static int MIN_SIZE = 1;

4、函数:函数第一规则少短小。第二条规则是还要更短小。如:使用if语句、else语句、while语句等,其中的代码块应该只有一行。该行大抵应该是一个函数调用语句。出现switch时,可以将其埋到抽象工厂底下。

5、函数参数:参数避免使用布尔型,如果是布尔型势必会造成该函数中出现判断。参数尽量少。

6、错误处理其实就是一件事,使用异常代替返回错误码,将错误处理代码分离出来。抽离try/catch。

7、注释:有些注释是必须的。有助于理解。

    好的注释种类--法律信息,提供信息,对意图的解释,阐释,警告,TODO注释,放大,公共API的Javadoc

    坏的注释种类--喃喃自语,多余注释,误导性注释,循轨式注释,日志式注释,废话注释,注释代码等

——————————————————————————————————————————————————————

先整理一些,后续再添加。

代码整洁

标签:

原文地址:http://my.oschina.net/u/260921/blog/509524

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!