java编码,不规范.doc

java编码,不规范 篇一：java代码规范详细版 Java代码规范 本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。本文档中没有说明的地方，请参看SUN Java标准代码规范。如果两边有冲突，以SUN Java标准为准。 1. 标识符命名规范 1.1 概述 标识符的命名力求做到统一、达意和简洁。尽量做到每个人按照规范来，多人开发如一人开发一样。 1.1.1 统一 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。 1.1.2 达意 达意是指，标识符能准确的表达出它所代表的意义，比如： newSupplier, OrderPaymentGatewayService等；而 supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是 order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。 1.1.3 简洁 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长， transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。 1.1.4 骆驼法则 Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如: supplierName, addNewContract，而不是 supplier_name, add_new_contract。 1.1.5 英文 vs 拼音 尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免拼音与英文混用。比如表示归档，用archive比较好, 用pigeonhole则不好，用guiDang尚可接受。 1.2 包名 使用小写字母如 com.amerisia.ebills，不要 com.amerisia.Ebills 单词间不要用字符隔开，比如 com.amerisia.ebills，而不要com.amerisia.ebills _util 1.3 类名 1.3.1 首字母大写 类名要首字母大写，比如 LCIssueInfoManagerEJB, LCIssueAction；不要 lcIssueInfoManagerEJB, lcIssueAction. 1.3.2 后缀 类名往往用不同的后缀表达额外的意思，如下表： 参数和局部变量名首字母小写，骆驼法则。尽量不要和域冲突，尽量表达这个变量在方法中的意义。 2. 代码格式 使用tab缩进源代码。 使用alt+shift+f （eclipse）来格式化代码,注：格式化代码后还需手动来调下。 2.1 源文件编码 源文件使用utf-8编码，结尾用unix n 分格。 2.2 行宽 行宽度不要超过80。Eclipse标准 2.3 包的导入 删除不用的导入，尽量不要使用整个包的导入。在eclipse下经常使用快捷键 ctrl+shift+o 修正导入。 2.4 类格式 2.5 域格式 每行只能声明一个域。 域的声明用空行隔开。 2.5 方法格式 2.6 代码块格式 2.6.1 缩进风格 大括号的开始在代码块开始的行尾，闭合在和代码块同一缩进的行首，同一层次的代码要保持整齐，例如： 篇二：java编码规范(华为) Prepared by 拟制 Reviewed by 评审人 Approved by 批准 Java语言编码规范 Date 日期 Date 日期 Date 日期 yyyy-mm-dd yyyy-mm-dd yyyy-mm-dd Revision Record 修订记录 Table of Contents 目录 1. 2. 3. 4. 4.1. 4.2. 5. 5.1. 5.2. 6. 6.1. 6.2. 7. 7.1. 7.2. 8. 8.1. 8.2. 范围 ...........................................