java编码规范文档讲述.docVIP

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