JAVA代码规范详细版.pdfVIP

(完整word版)JAVA代码规范详细版--第1页 JAVA代码规范 本Java 代码规范以SUN 的标准Java 代码规范为基础，为适应我们公司的实际需要，可能 会做一些修改。本文档中没有说明的地方，请参看SUN Java 标准代码规范。如果两边有冲 突，以SUN Java 标准为准。 1. 标识符命名规范 1.1 概述 标识符的命名力求做到统一、达意和简洁。 1.1.1 统一 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用 su lier，也可以用provider，但是我们只能选定一个使用，至少在一个Java 项目中保持统 一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使 不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。 1.1.2 达意 达意是指，标识符能准确的表达出它所代表的意义，比如： newSu lier, OrderPaymentGatewayService 等；而 su lier1, service2，idtts 等则不是好的命名方式。 准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是order，显然 没有正确表达。同样的，su lier1, 远没有targetSu lier 意义丰富。 1.1.3 简洁 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比 如：theOrderNameOfTheTargetSu lierWhichIsTransfered 太长， transferedTargetSu lierOrderName 则较好，但是transTgtSplOrdNm 就不好了。省略元 音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。 1.1.4 骆驼法则 Java 中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之 间不使用特殊符号分割，而是通过首字母大写来分割。比如: su lierName, addNewContract，而不是 su lier_name, add_new_contract。 (完整word版)JAVA代码规范详细版--第1页 (完整word版)JAVA代码规范详细版--第2页 1.1.5 英文 vs 拼音 尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免 拼音与英文混用。比如表示归档，用archive 比较好, 用pigeonhole 则不好，用guiDang 尚可接受。 1.2 包名 使用小写字母如 com.xxx.settlment，不要 com.xxx.Settlement 单词间不要用字符隔开，比如 com.xxx.settlment.jsfutil，而不要com.xxx.settlement.jsf_util 1.3 类名 1.3.1 首字母大写 类名要首字母大写，比如 SupplierService, PaymentOrderAction；不要 supplierService, paymentOrderAction. 1.3.2 后缀 类名往往用不同的后缀表达额外的意思，如下表： 后缀名 意义 举例 表明这个类是个服务类，里面包含了给其他类提同 Service PaymentOrderService 业务服务的方法 Impl 这个类是一