《java编码规范文档》由会员分享，可在线阅读，更多相关《java编码规范文档（16页珍藏版）》请在金锄头文库上搜索。
1、 Java代码规1. 标识符命名规1.1 简洁简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比方：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长， transferedTargetSupplierOrderName那么较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。1.2 英文 vs 拼音尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行那么使用汉语拼音，防止拼音与英文混用。比方表示归档，用archive比拟好, 用pige
2、onhole那么不好，用guiDang尚可承受。1.3 包名1.4 类名1.4.1 首字母大写类名要首字母大写，比方 SupplierService, PaymentOrderAction；不要 supplierService, paymentOrderAction.1.5 方法名首字母小写，如 addOrder() 不要 AddOrder()动词在前，如 addOrder()，不要orderAdd()名称不要太长动词前缀往往表达特定的含义，如下表：前缀名意义举例create创立createOrder()delete删除deleteOrder()add创立，暗示新创立的对象属于某个集合addP
3、aidOrder()remove删除removeOrder()init或那么initialize初始化，暗示会做些诸如获取资源等特殊动作initializeObjectPooldestroy销毁，暗示会做些诸如释放资源的特殊动作destroyObjectPoolopen翻开openConnection()close关闭closeConnection()0)System.out.println(arg);for(int i =0; i b )/do something here;2.4.2.2 二元三元运算符两边用一个空格隔开如下：a + b = c;b - d = e;return a = b
4、 ?1:0;不能如下：a+b=c;b-d=e;return a=b?1:0;2.4.2.3 逗号语句后如不换行，紧跟一个空格如下：call(a, b, c);不能如下：call(a,b,c);2.4.3 空行的使用空行可以表达代码在语义上的分割，注释的作用围，等等。将类似操作，或一组操作放在一起不用空行隔开，而用空行隔开不同组的代码， 如图：order = orderDao.findOrderById(id);/update propertiesorder.setUserName(userName);order.setPrice(456);order.setStatus(PAID);order
5、Service.updateTotalAmount(order);session.saveOrUpdate(order);上例中的空行，使注释的作用域很明显. 连续两行的空行代表更大的语义分割。 方法之间用空行分割 域之间用空行分割 超过十行的代码如果还不用空行分割，就会增加阅读困难3 注释规3.1 注释 vs 代码 注释宜少二精，不宜多而滥，更不能误导 命名达意，结构清晰， 类和方法等责任明确，往往不需要，或者只需要很少注释，就可以让人读懂；相反，代码混乱，再多的注释都不能弥补。所以，应领先在代码本身下功夫。 不能正确表达代码意义的注释，只会损害代码的可读性。 过于详细的注释，对显而易见的代
6、码添加的注释，罗嗦的注释，还不如不写。 注释要和代码同步，过多的注释会成为开发的负担 注释不是用来管理代码版本的，如果有代码不要了，直接删除，svn会有记录的，不要注释掉，否那么以后没人知道那段注释掉的代码该不该删除。3.2 Java Doc说明类、域和方法等的意义和用法等的注释，要以javadoc的方式来写。Java Doc是个类的使用者来看的，主要介绍 是什么，怎么用等信息。但凡类的使用者需要知道，都要用Java Doc 来写。非Java Doc的注释，往往是个代码的维护者看的，着重告述读者为什么这样写，如何修改，注意什么问题等。 如下：/* This is a class comment
7、*/publicclass TestClass /* * This is a field comment */publicString name;/* * This is a method comment */publicvoid call()3.3 块级别注释3.3.1 块级别注释，单行时用 /, 多行时用 /* . */。3.3.2 较短的代码块用空行表示注释作用域3.3.3 较长的代码块要用/*- start: -*/和/*- end: -*/包围如：/*-start: 订单处理 - */取得daoOrderDao dao = Factory.getDao(OrderDao);/* 查询
8、订单 */Order order = dao.findById(456);/更新订单order.setUserName(uu);order.setPassword(pass);order.setPrice(ddd);orderDao.save(order);/*-end: 订单处理 - */3.3.4 可以考虑使用大括号来表示注释围使用大括号表示注释作用围的例子：/*-订单处理 - */取得dao OrderDao dao = Factory.getDao(OrderDao);/* 查询订单 */ Order order = dao.findById(456);/更新订单 order.setUserName(uu); order.setPassword(pass); order.setPrice(ddd); orderDao.save(order);3.4 行注释行注释用 / 写在行尾4 最正确实践和禁忌4.1 每次保存的时候，都让你的代码是最美的程序员都是懒惰的，不要想着等我完成了功能，再来优化代码的格式和结构，等真的把功能完成，很少有人会再愿意回头调整代码。4.24.3 每个if while for等语句，都不要省略大括号看下面的代码：if(a b) a+;如果在以后维护的时候，需要在a b 时，把b+，一步小心就会写成：
