Java代码规范详细版范本模板文档格式.docx

1、EJB表示这个类为EJB类LCIssueInfoManagerEJBService表明这个类是个服务类,里面包含了给其他类提同业务服务的方法PaymentOrderServiceImpl这个类是一个实现类，而不是接口PaymentOrderServiceImplInter这个类是一个接口LifeCycleInterDao这个类封装了数据访问方法PaymentOrderDaoAction直接处理页面请求,管理页面逻辑了类UpdateOrderListActionListener响应某种事件的类PaymentSuccessListenerEvent这个类代表了某种事件PaymentSuccessE

2、ventServlet一个ServletPaymentCallbackServletFactory生成某种对象工厂的类PaymentOrderFactoryAdapter用来连接某种以前不被支持的对象的类DatabaseLogAdapterJob某种按时间运行的任务PaymentOrderCancelJobWrapper这是一个包装类，为了给某个类提供没有的能力SelectableOrderListWrapperBean这是一个POJOMenuStateBean1.4 方法名首字母小写，如 addOrder（） 不要 AddOrder（）动词在前，如 addOrder（），不要orderAdd

3、（）查询方法要查询的内容在前，条件在后。 如getXxByXx（）动词前缀往往表达特定的含义，如下表：前缀名create创建createOrder（）delete删除deleteOrder（）add创建，暗示新创建的对象属于某个集合addPaidOrder（）removeremoveOrder（）init或则initialize初始化,暗示会做些诸如获取资源等特殊动作initializeObjectPooldestroy销毁，暗示会做些诸如释放资源的特殊动作destroyObjectPoolopen打开openConnection（）close关闭closeConnection（） b ） /

4、do something here;6.2.2运算符两边用一个空格隔开 例如： 不要写成: 6.2.3 逗号语句后如不换行，紧跟一个空格如下：call（a, b, c）;不能如下：call（a，b，c）；6.3 空行的使用空行可以表达代码在语义上的分割，注释的作用范围,等等。将类似操作，或一组操作放在一起不用空行隔开，而用空行隔开不同组的代码， 如图：上例中的空行,使注释的作用域很明显.连续两行的空行代表更大的语义分割。方法之间用空行分割（尽量用一行空行）域之间用空行分割超过十行的代码如果还不用空行分割，就会增加阅读困难3. 注释规范3.1 注释 vs 代码注释宜少而精，不宜多而滥，更不能误导

5、命名达意,结构清晰, 类和方法等责任明确，往往不需要，或者只需要很少注释，就可以让人读懂;相反,代码混乱，再多的注释都不能弥补。所以,应当先在代码本身下功夫。不能正确表达代码意义的注释，只会损害代码的可读性。过于详细的注释，对显而易见的代码添加的注释,罗嗦的注释，还不如不写。注释要和代码同步，过多的注释会成为开发的负担3。2 Java Doc表明类、域和方法等的意义和用法等的注释，要以javadoc的方式来写。Java Doc是个类的使用者来看的，主要介绍 是什么，怎么用等信息。凡是类的使用者需要知道,都要用Java Doc 来写.非Java Doc的注释,往往是个代码的维护者看的，着重告述读

6、者为什么这样写,如何修改,注意什么问题等。 如下：类3.3 块级别注释3.3.1 块级别注释，单行时用 /, 多行时用 /* 。 /。3.3。2 较短的代码块用空行表示注释作用域3.3.3 较长的代码块要用/- start： -/和/*- end: -*/包围4 行内注释行内注释用 / 写在行尾4 最佳实践和禁忌4。1 每次保存的时候，都让你的代码是最美的程序员都是懒惰的,不要想着等我完成了功能,再来优化代码的格式和结构，等真的把功能完成，很少有人会再愿意回头调整代码。2 使用log而不是System。out.println（）log可以设定级别，可以控制输出到哪里,容易区分是在代码的什么地方

7、打印的，而System.out.print则不行.而且，System。out.print的速度很慢。所以，除非是有意的,否则，都要用log。至少在提交到svn之前把System。out.print换成log.4.3 每个if while for等语句，都不要省略大括号看下面的代码：if （a b） a+;如果在以后维护的时候,需要在a b 时，把b+，一步小心就会写成： b+；这样就错了，因为无论a和b是什么关系，b+都会执行。 如果一开始就这样写： b） a+；相信没有哪个笨蛋会把b+添加错的。而且，这个大括号使作用范围更明显，尤其是后面那行很长要折行时。4 善用TODO:在代码中加入 /T

8、ODO： ，大部分的ide都会帮你提示，让你知道你还有什么事没有做.比如：if （order.isPaid（） /TODO: 更新订单4.5 在需要留空的地方放一个空语句或注释，告述读者，你是故意的if （！exists（order） ;或： /nothing to do6 不要再对boolean值做true false判断比如:if （order.isPaid（） = true） / Do something here不如写成： /Do something here后者读起来就很是 if order is paid， . 要比 if orders isPaid method returns

9、true， 更容易理解4.7 减少代码嵌套层次代码嵌套层次达3层以上时，一般人理解起来都会困难。下面的代码是一个简单的例子:public void demo（int a， int b， int c） if （a b） if （b c） doJobA（）; else if （b c） doJobB（） else if （b c） if （a c） doJobC（）; 减少嵌套的方法有很多：合并条件利用 return 以省略后面的else利用子方法比如上例，合并条件后成为：public void demo（int a, int b, int c） if （a b & b c） b & c doJo

10、bB（）； if （a = b & c b & a doJobC（）；如果利用return 则成为： c） return; if （a 利用子方法，就是将嵌套的程序提取出来放到另外的方法里。4.8 程序职责单一关注点分离是软件开发的真理。人类自所以能够完成复杂的工作，就是因为人类能够将工作分解到较小级别的任务上，在做每个任务时关注更少的东西。让程序单元的职责单一,可以使你在编写这段程序时关注更少的东西，从而降低难度，减少出错。4.9 变量的声明,初始化和被使用尽量放到一起比方说如下代码:int orderNum= getOrderNum（）;/do something withou order

11、Num herecall（orderNum）;上例中的注释处代表了一段和orderNum不相关的代码。orderNum的声明和初始化离被使用的地方相隔了很多行的代码，这样做不好，不如这样：4.10 变量的判断，常量尽量使用定义好的常量if（param.get（”logtype）.equals（”2）map.put（certificatetype”, param。get（idtype）;上例突然来个equals判断，根本看不懂要做什么，不如这样:/logtype类型，为2时：证件号码;public String LOGTYPE_IDENTIFICATION_NUMBER = 2”;if（para

12、m。logtype）.equals（LOGTYPE_IDENTIFICATION_NUMBER）map.put（”certificatetype, param.get（idtype”）；11 缩小变量的作用域能用局部变量的，不要使用实例变量,能用实例变量的，不要使用类变量.变量的生存期越短，以为着它被误用的机会越小，同一时刻程序员要关注的变量的状态越少.实例变量和类变量默认都不是线程安全的，局部变量是线程安全的.比如如下代码：public class OrderPayAction private Order order; public void doAction（） order = order

13、Dao。findOrder（）; doJob1（）； doJob2（）； private void doJob1（） doSomething（order）; private void doJob2（） doOtherThing（order）；上例中order只不过担当了在方法间传递参数之用，用下面的方法更好:public class OrderPayAction public void doAction（） order = orderDao.findOrder（）； doJob1（order）; doJob2（order）； private void doJob1（Order order） p

14、rivate void doJob2（Order order） doOtherThing（order）;4.12 尽量不要用参数来带回方法运算结果public void calculate（Order order） int result = 0； /do lots of computing and store it in the result order.setResult（result）；public void action（） findOrder（）； calculate（order）； / do lots of things about order例子中calculate方法通过传入的o

15、rder对象来存储结果, 不如如下写：public int calculate（Order order） int result = 0; return result; order。setResult（calculate（order）；13捕获的异常不能忽视（1） 对捕获的异常不做响应是极少正确的,典型的响应方式是打印日志，切记不要使用e。printStackTrace（），异常捕捉了又不写日志,查起来是非常麻烦的tryHssaleCustomerLevel custlevel = hSsaleRepository。queryHssaleCustomerLevel（customerleverpa

16、ram）;if（custlevel！=null）return HundSunInterface。getCustomerLevelMoney（custlevel）；elsereturn OTHER；catch（Exception e）log.error（e.getMessage（），e）；（2）确实是不需要在catch块中做任何响应，需要做注释加以说明（如下面的例子）try int i = Integer。parseInt（response）； return handleNumericResponse（i）; catch （NumberFormatException ok） / its not numeric; thats fine, just continuereturn handleTextResponse（response）;4.14 最后，还是要多些单元测试类，因为单元测试类可以提前发现代码中的好多问题。