java编码规范文档

《java编码规范文档》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、Java代码规范1.标识符命名规范1.1简洁简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。1.2英文vs拼音尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免拼音与英文混

2、用。比如表示归档，用archive比较好,用pigeonhole则不好，用guiDang尚可接受。1.3包名使用小写字母如com.xxx.settlment，不要com.xxx.Settlement单词间不要用字符隔开，比如com.xxx.settlment.jsfutil，而不要com.xxx.settlement.jsf_util1.4类名1.4.1首字母大写类名要首字母大写，比如SupplierService,PaymentOrderAction；不要supplierService,paymentOrderAction

3、.1.5方法名首字母小写，如addOrder()不要AddOrder()动词在前，如addOrder()，不要orderAdd()名称不要太长动词前缀往往表达特定的含义，如下表：前缀名意义举例create创建createOrder()delete删除deleteOrder()add创建，暗示新创建的对象属于某个集合addPaidOrder()remove删除removeOrder()init或则initialize初始化，暗示会做些诸如获取资源等特殊动作initializeObjectPooldestroy销毁，暗示会做些诸

4、如释放资源的特殊动作destroyObjectPoolopen打开openConnection()close关闭closeConnection()

5、行某个过程或流程doOrderCancelJob()dispatch判断程序流程转向dispatchUserRequest()start开始startOrderProcessing()stop结束stopOrderProcessing()send发送某个消息或事件sendOrderPaidMessage()receive接受消息或时间receiveOrderPaidMessgae()respond响应用户动作responseOrderListItemClicked()find查找对象findNewSupplier()upda

6、te更新对象updateCommission()find方法在业务层尽量表达业务含义，比如findUnsettledOrders()，查询未结算订单，而不要findOrdersByStatus()。数据访问层，find,update等方法可以表达要执行的sql，比如findByStatusAndSupplierIdOrderByName(Status.PAID,345)1.1域（field）名1.1.1静态常量全大写用下划线分割，如publicstaticfindStringORDER_PAID_EVENT=“ORDER_P

7、AID_EVENT”;1.1.1枚举全大写，用下划线分割，如publicenumEvents{ORDER_PAID,ORDER_CREATED}1.1.2其他首字母小写，骆驼法则，如：publicStringorderName;1.2局部变量名参数和局部变量名首字母小写，骆驼法则。尽量不要和域冲突，尽量表达这个变量在方法中的意义。1.代码格式用空格字符缩进源代码，不要用tab，每个缩进4个空格。1.1包的导入删除不用的导入，尽量不要使用整个包的导入。在eclipse下经常使用快捷键ctrl+shift+o修正导入。1.2域格

8、式每行只能声明一个域。域的声明用空行隔开。1.3代码块格式2.4.1缩进风格大括号的开始在代码块开始的行尾，闭合在和代码块同一缩进的行首，例如：packagecom.test; publicclassTestStyleextendsSomeClassimplementsAppleInter