java编码规范文档.doc

Java代码规范标识符命名规范简洁简洁是指,在统一和达意的前提下,用尽量少的标识符。如果不能达意,宁愿不要简洁。比如:theOrderNameOfTheTargetSupplierWhichIsTransfered太长,transferedTargetSupplierOrderName则较好,但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用,我们的英语往往还没有好到看得懂奇怪的缩写。英文vs拼音尽量使用通俗易懂的英文单词,如果不会可以向队友求助,实在不行则使用汉语拼音,避免拼音与英文混用。比如表示归档,用archive比较好,用pigeonhole则不好,用guiDang尚可接受。包名使用小写字母如,不要单词间不要用字符隔开,比如,而不要类名首字母大写类名要首字母大写,比如SupplierService,PaymentOrderAction;不要supplierService,,如addOrder()不要AddOrder()动词在前,如addOrder(),不要orderAdd()名称不要太长动词前缀往往表达特定的含义,如下表:前缀名意义举例create创建createOrder()delete删除deleteOrder()add创建,暗示新创建的对象属于某个集合addPaidOrder()remove删除removeOrder()init或则initialize初始化,暗示会做些诸如获取资源等特殊动作initializeObjectPooldestroy销毁,暗示会做些诸如释放资源的特殊动作destroyObjectPoolopen打开openConnection()close关闭closeConnection()<read读取readUserName()write写入writeUserName()get获得getName()set设置setName()prepare准备prepareOrderList()copy复制copyCustomerList()modity修改modifyActualTotalAmount()mission()do执行某个过程或流程doOrderCancelJob()dispatch判断程序流程转向dispatchUserRequest()start开始startOrderProcessing()stop结束stopOrderProcessing()send发送某个消息或事件sendOrderPaidMessage()receive接受消息或时间receiveOrderPaidMessgae()respond响应用户动作responseOrderListItemClicked()find查找对象findNewSupplier()mission()find方法在业务层尽量表达业务含义,比如findUnsettledOrders(),查询未结算订单,而不要findOrdersByStatus()。数据访问层,find,update等方法可以表达要执行的sql,比如findByStatusAndSupplierIdOrderByName(,345)域(field)名静态常量全大写用下划线分割,如publicstaticfindStringORDER_PAID_EVENT=“ORDER_PAID_EVENT”;枚举全大写,用下划线分割,如publicenumEvents{ORDER_PAID,ORDER_CREATED}其他首字母小写,骆驼法则,如:publicStringorderName;局部变量名参数和局部变量名首字母小写,骆驼法则。尽量不要和域冲突,尽量表达这个变量在方法中的意义。代码格式用空格字符缩进源代码,不要用tab,每个缩进4个空格。包的导入删除不用的导入,尽量不要使用整个包的导入。在eclipse下经常使用快捷键ctrl+shift+o修正导入。域格式每行只能声明一个域。域的声明用空行隔开。代码块格式缩进风格大括号的开始在代码块开始的行尾,闭合在和代码块同一缩进的行首,例如:.test; lassTestStyleextendsSomeClassimplementsAppleInter,BananaInter{ publicstaticfinalStringTHIS_IS_CONST="CONSTVALUE"; privatestaticvoidmain(String[]args){intlocalVariable=0;} pute(Stringarg){if(()>0){;} for(inti=0;i<10;i++){;} while(condition){ } do{