java代码规范模板

Info DMS

java代码开发模板

作者：周清江

发布日期：2007-11-23

当前版本：0.1

上海英孚思为信息科技有限公司

修订历史纪录

代码开发环境修订Info DMS 英孚思为机密文件

代码开发环境修订Info DMS 英孚思为机密文件

代码开发环境修订 Info DMS

英孚思为机密文件 Java 开发模板文件导入

1． 导入统一的版权信息和类、方法、字段注释格式文件

第一步 打开 Preference,选中

code_style->>Code_Templates

第二步选择Import …

文件名：code_style_templates.xml

代码开发环境修订 Info DMS

英孚思为机密文件

2． 导入统一代码样式文件

第一步 打开 Preference,选中code_style->>Fromatter

代码开发环境修订 Info DMS

英孚思为机密文件

第二步选择Import … 文件名：

code_style_formatter.xml

File Descript统一定义

导入统一的版权信息以后当新建每个JA V A以后，JA V A文件头内容统一为：/**

*Copyright(c)2006-2008OEM Infoservice Corp.2006-2008,All Rights Reserved.

*This software is published under the Infoservice DMS Service Inner Solution Team.

*License version 1.0,a copy of which has been included with this *distribution in the LICENSE.txt file.

*

*@File name:

https://www.doczj.com/doc/5714781945.html,base.actions.MaintainBrand.java

*@Create on:2007-9-30

*@Author:kevin

*

*@ChangeList

*---------------------------------------------------

*NO Date Editor ChangeReasons

* 1.2007-9-30kevin Add

*

*/

注意：

1.如果文件不是新建而是从原来的项目中拷贝过来，请修改包名

和类名.（@File name:）

https://www.doczj.com/doc/5714781945.html,base.actions.MaintainBrand.java

2.如果因为重要的业务逻辑而修改过文件，不要忘了在(@ChangeList)加上相关修改日期、修改人和简单描述修改原因。

Class Body( Action) 描述内容

在一些业务比较简单的Action文件中Class Body内容没有设置，这样生成的JA V ADOC文档中这些Action就很难读懂。对于业务相对简单的Action也需对该业务内容做简单的描述，如下:

代码开发环境修订Info DMS 英孚思为机密文件

代码开发环境修订 Info DMS

英孚思为机密文件

注意：

1. 由于文件新建时不会自动产生上面的注释代码，此时可以输入“/**”加上回车就会出现注释模板，再在业务描述中描述此方法的功能。

2. 如果方法内有复杂的业务逻辑，要多用 “//取得新增、修改状态参数”这样的注释，以增强代码的可读性。

3．些注释同样应用于所有METHOD （除PO 类），如FOFACTORY 方法和COMMON 下的一些工具类方法。 字段的描述

对于一些有特定业务说明的字段要加以注释，比如常量类的，数据字典还有状态等。

异常的处理

1.

CVS提交Comment内容填写

在进行代码提交时，对要提交的代码进行简要的描述；描述当前提交的代码与仓库中的代码区别及修改理由。

代码开发环境修订Info DMS 英孚思为机密文件

代码开发环境修订Info DMS 英孚思为机密文件

Java开发规范

Java开发规范

目录 第1章序言 (4) 第2章java一般性研发规范 (5) 2.1 代码格式 (5) 2.1.1包、类、方法的命名规范: (5) 2.1.2方法的命名应注意避免与java中具有特殊意义的名称例如equals， hashCode，clone，finalizer等冲突 (7) 2.1.3Java bean中取得boolean类型的属性值必须使用is****形式命名 (9) 2.1.4if,else,while,for等必须使用{} (9) 2.1.5类必须包含在包里，禁止出现无包的类 (10) 2.1.6类和方法必须拥有注释，注释量占总体代码25%以上，类头部，以及方法 头部的注释应符合javadoc标准。 (11) 2.2 基本语法 (12) 2.2.1不能随意捕捉异常，原则上谁捕捉谁处理 (12) 2.2.2if，while，try，finally，switch ，synchronized ，static instantiation 里面应有相应的逻辑处理，不能为空。 (13) 2.2.3在处理循环中，不能在程序中人为的改变步长。 (14) 2.2.4将简单类型int，short，float，double等转化成字符串时，需使用其对 应类的toString方法。 (14) 2.2.5javaBean中hashCode，以及equals方法必须同时override。 (15) 2.2.6懒式方式创建对象：不能采用双检查惯用法 (18) 2.2.7不能在finally中返回值。 (19) 2.2.8Boolean实例化时，应用使用Boolean.valueOf，Boolean.TRUE， Boolean.FALSE。 (19) 2.2.9Integer,Byte,Short,Long等实例化时，应用使用valueOf (20) 2.2.10对于多个if语句嵌套的情况下能够整合尽量整合。 (20) 2.2.11override function，不能只有super.function语句，否则视为无效代码 21 2.2.12Collection.toArray的注意事项。 (21) 2.2.13对于BigDecimal方法，应避免使用float值，double值进行创建，应使 用字符串形式创建。 (22) 2.2.14String,BigDecimal,BigInteger等值类型调用replace，add等方法的注 意事项。 (23) 2.2.15需要注意的引起NullException的语句。 (23) 2.2.16ResultSet使用next时，需要判断是否具有记录再进行一下步操作。 25 2.2.17字符串使用相应的规则。 (25) 2.2.18禁止直接调用 System.gc(),System.getRuntime().gc(),System.runFinalization()。 (27) 2.2.19finalize相应的规则。 (27) 2.2.20禁止在代码中使用System.out,ex.printStackTrace打印日志。 (28) 2.2.21系统资源释放（谁创建的，谁关闭） (29) 2.2.22使用Clone时相应的规则。 (32) 2.2.23java Bean类必须实现Serialize接口。 (33)

系统开发代码规范

系统开发代码规范北京慧点科技开发有限公司 2005年9月

目录 一、Domino网络域及组织的命名................................................................ 错误！未定义书签。 二、Domino服务器的命名............................................................................ 错误！未定义书签。 三、系统验证字的命名................................................................................. 错误！未定义书签。 四、用户和群组的命名................................................................................. 错误！未定义书签。 五、模块数据库的命名................................................................................. 错误！未定义书签。 六、数据库各设计元素的命名..................................................................... 错误！未定义书签。 七、编码规范................................................................................................. 错误！未定义书签。 八、产品开发规范......................................................................................... 错误！未定义书签。 九、提交数据库备份命名规范..................................................................... 错误！未定义书签。

代码编写规范

知识管理系统代码编写规范 一、介绍 本文档为《知识管理系统》代码编写规范，为保证代码风格的一致性和后期的可维护性，文档讲述的内容要求所有开发人员必须遵守。 本规范主要参考了Google Java Style，包括了其他一些业界约定俗成的公约和普遍采用的标准。本规范并非最终标准，一些规定还需再做商讨。 1.1 术语说明 本文档除非特殊说明，否则： 1. 类（class）统指普通类、枚举类、接口和注解类型。 2. 注释（comment）只用来指实现注释（implementation comments）。我们不使用“文 档注释”这样的说法，而会直接说Javadoc。 其他“术语说明”，将在文档中需要说明的地方单独说明。 1.2 文档说明 本文档中的代码并不一定符合所有规范。即使这些代码遵循本规范，但这不是唯一的代码方式。例子中可选的格式风格也不应该作为强制执行的规范。

二、源码文件基础 2.1 文件名 源文件以其最顶层的类名来命名，大小写敏感，文件扩展名为.java。 2.2 文件编码：UTF-8 源码文件使用UTF-8编码。 2.3 特殊字符 2.3.1 空格字符 除了换行符外，ASCII 水平空白字符（0x20）是源码文件中唯一支持的空格字符。这意味着： 1. 其他空白字符将被转义。 2. Tab字符不被用作缩进控制。 2.3.2 特殊转义字符串 任何需要转义字符串表示的字符（例如\b, \t, \n, \f, \r, \", \'和\\等），采用这种转义字符串的方式表示，而不采用对应字符的八进制数（例如\012）或Unicode 码（例如\u000a）表示。 2.3.3 非ASCII 字符 对于其余非ASCII字符，直接使用Unicode字符（例如∞），或者对应的Unicode 码（例如\u221e）转义都是允许的。唯一需要考虑的是，何种方式更能使代码容易阅读和理解。

JAVA代码规范

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 拼音

项目开发及编码规范

项目开发规范文档修订历史记录

1.简介 目的 1、用于规范指导开发组进行开发 2、便于成员间的沟通与交流。 3、有助于项目质量和稳定。 4、为后期维护提供支持 2. 项目开发流程 项目开发过程归纳分为以下步骤： 1. 建立SVN项目版本控制。包括文档，源码，Lib包等。 2. 了解需求，并对需求文档的书写。(见文档结构规则附录)。 3. 详细设计文档。(见文档结构规则附录)。 功能模块设计，重要模块的算法设计。 数据库设计等。 根据需求定义开发平台及环境。 4. 编码。 搭建开发平台，配置开发环境。 编码。 单元测试案例。 5. 书写软件安装手册文件，数据库脚本文件，以及注意事项(release notes)。 6. 交互测试组测试。根据测试组测试结果是否回归第4步（测试回归最好不要超过2 次）。 7. 测试通过，交付上线使用。 维护手册 使用手册

3. 代码规范 Java 代码规范 3.1.1 Java类名 类名可由：英文字母，数字，下划线组成。（数字，下划线不能够开头） 类名由一个或者多个单词组成。单词通常要求简洁明了达意。能够通过类名能够大致了解此类的作用和用途。 类名要求首字母大写，多个单词组成类名时，单词的首字母要求大写。 建议：类名不要过于简单或者太长。可以对单词采用简化的名称：入： Number 简化为：num 。 3.1.2 Java类结构 类仅作为数据结构，没有行为，他封装了一组或者相似的一些行为方法。所以一个类尽量功能单一，或者功能类似共有行为的。一个类不要过于庞大。 通常情况下： 一般逻辑类中应该有构造方法和main方法，main方法中应该有测试代码。 每个类应该有 toString() 方法。 3.1.2.1 包和引入语句 在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。 报名的定义全部是小写字母。具体定义依据项目而定。 引入包时候，同一类型的归纳到一块，用空行隔开。例如： import 3.1.2 类注释 Java类开头应该有相应的注释：类版本描述，作者签名，日期时间，公司备注，类的功能作用相关描述等。（详细查看：注释） 3.1.2.2 类成员变量 a) 类变量要求放在类的开始声明。一行声明一个。 b) 变量名称首字母要求小写。其他命名规则类似与类名。 c) static , final 类型的变量，字母要求全部大写。 d) 尽量在声明局部变量的同时初始化。 e) 避免局部变量和成员变量同名，覆盖了成员变量。 f) 尽量变量私有化，缩小变量的作用域。 3.1.2.3 类成员方法 a) 方法名命名规则类似于成员变量命名规则。 b) 成员方法尽量私有化。

JAVA开发规范文档

Java 开发规范文档 一：目的 使本组织能以标准的，规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性，可读性，可修改性，可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。 二：代码组织与风格 1：长度：为便于阅读和理解，单个函数的有效代码长度当尽量在100行以内（不包括注释行），当功能模块过大时往往采用使用子函数将相应的功能抽取出来，这也有利于提高代码的重用度。 2：单个类不宜过大，当出现此类过大时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过1500行。尽量避免使用大类和长方法。3：间隔：类，方法及功能块间等应以空行相隔，以增加可读性，但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。 三：注释 1：注释应该增加代码的清晰度。代码注释的目的时要使代码更易于被其他开发人员等理解。2：保持注释的简洁。 3：注释信息应该包括代码的功能。 4：除变量定义等较短语句的注释使用行尾注释外，其他注释当避免使用行尾注释。 5：JavaDoc规范 对类，方法，变量等注释需要符合javadoc规范，对每个类，方法都应详细说明其功能条件，参数等。类注释中应当包含版本和作者信息。 1）类，接口注释在类，接口定义之前当对其进行注释，包括类，接口的目的，作用，功能，继承于何种父类，实现的接口，实现的算法，使用方法，示例程序等。 2）方法注释以明确该方法功能，作者，各参数含义以及返回值等。

3）其他注释应对重要的变量及不易理解的分支条件表达式加以注释，以说明其含义等。四命名规范 1：对变量，类，接口及包的命名应该使用英文。严禁使用汉语拼音及不相关单词命名。更不可以使用汉字来进行命名。采用大小写混合，提高名字的可读性。一般应该采用小写字母，但时类和接口的名称的首字母，以及任何中间单词的首字母应该大写。包名全部小写。 2：尽量少用缩写，但如果一定要用，当使用公共缩写和习惯缩写等，如implement可缩写为impl，manager可缩写成mgr等。 3：包名一般以项目或模块名命名，少用缩写和长名，一律小写。 包名按照如下规定组成[基本包].[项目名].[模块名].[子模块名].…. 如：org.skyinn.skyhome.dao.hibernate。 不得将类直接定义在基本包下，所有项目中的类，接口等都当定义在各自的项目和模块包中。 4：类，接口所有单词首字母大写，最好能够见名知意。一般采用名词。接口可带I前缀。 或able，dao后缀。 5：字段常量采用完整的英文大写单词，单词之间用下划线连接，如DEFAULT_V ALUE. 6：变量和参数对不易识别出该变量类型的变量应使用类型缩写作其前缀，如字符串使用strXXX，boolean使用isXXX，hasXXX等等。除第一个单词外其余单词的首字母大写。7：集合采用复数名称来表示队列中存放的对象类型，名词采用完整的英文描述。 例如：Vector vProducts= new Vector(); Array aryUsers= new Array(); 8：方法方法的名称应采用完整的英文描述，大小写混合使用：所有中间单词的第一个字母大写。方法名称的第一个单词常常采用一个强烈动作色彩的动词。取值类使用get前缀，设置类使用set前缀。例如getName（），setSarry（）。 9：异常类名由表示该异常类型的单词和Exception组成，如ActionException。异常实例一般使用e，ex等。 10：数组的命名 数组应该总是用下面的方式来命名：byte[] buffer; 而不是：byte buffer[]; 五：类与接口 1：基本原则：一个类只做一件事情。另一个原则时根据每个类的职责进行划分，比如用User 来存放用户信息，而用UserDAO来对用户信息进行数据访问操作，用UserServer对用户信息的业务操作等等。多个类中使用相同方法时将其方法提到一个接口中或使用抽象类，尽量提高重用度。不希望被实例化的类的缺省构造方法声明为private。 2：一般而言，接口定义行为，而抽象类定义属性和共有行为，注意2者的取舍，在设计中可由接口定义公用的行为，由一个抽象类来实现其部分或全部方法，以给子类提供统一的行为为定义。 六：方法 一个方法只完成一项功能。方法参数类型和参数返回值尽量接口化，以屏蔽具体的实现细节，提高系统的可扩展性，例如：public void addUser（List userList）{} public List listAllUsers（）{} 七：Web 命名规范 一：jsp页面命名 对于某个功能块的增删改查页面定义，最好使用

编码规范

编码规范 1.编写目的 本规范的目的在于编写可靠的、一致的、便于理解的JAVA源代码，并且写出的代码被其他人阅读，所有的JAVA代码保持良好的致性，容易在以后的阶段中进行维护和升级。同时，也是为了通过一定时间的实践，增加我们的软件产品的投入产出量，以提高我们的工作效率。 2.适应范围 适用于JAVA程序开发人员，或后续开发人员。可以方便系统的开发与维护，使系统开发与维护可以顺利展开。 3.代码命名一般原则 我们开发的是一个JSP新闻发布系统，用的编码方式是JAVA，因此用的命名总原则是： 3.1.用全英文单词命名的方式，准确地描述变量、属性、类等。 如：使用firstNname、grandTotal、等命名就比x1、y1、fn等更容易让人理解其含义，尽管它们的长度要大一些。 3.2．采用一些更加准确的术语来命名。 例如：如果我们的用户称他们的clients为customers ，那么我们就应该用customer来命名，而不是采用client来命名。这是一些细微的地方，但也希望能注意。 3.3．采用大小写混合的方式来命名，以便命名有很好的可读性。 在JAVA代码中，将采用如下原则：类或接口命名中每个单词的首字母均大写，而单词的剩余部分均小写。其它像变量、成员方法、属性等除第一个单词全部小写以外，其它单词的首写字母均大写，而单词的剩余部分均小写。 3.4．尽量少用单词的缩写形式，但如果一定要用，则选择大家通用的缩写方式，并且要在本JAVA源代码中坚持用它，而不要一会用这种缩写方式，一会用那种 缩写方式。 比如，如果要用“number”的缩写方式，则可用“no”或“num”两种缩写方式，而不要用“nu”这种大家不常用的缩写方式，并且要保持不变。 3.5．尽量避免太长的命名，一般以少于20个字符为宜。

华为JAVA编程规范

1 Java 编程规范 1.1 排版 1.1.1 规则 规则1程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。(1.42+) 说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。 规则2分界符（如大括号…{?和…}?）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序 或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例: if (a>b) { doStart(); } 规则3较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐， 语句可读。(1.42+) 示例： if (logger.isDebugEnabled()) { logger.debug("Session destroyed,call-id" + event.getSession().getCallId()); } 规则4不允许把多个短语句写在一行中，即一行只写一条语句(1.42+) 说明：阅读代码更加清晰 示例：如下例子不符合规范。 Object o = new Object(); Object b = null; 规则5if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。 (1.42+) 说明：阅读代码更加清晰，减少错误产生 示例： if (a>b) { doStart(); }

java项目团队开发规范

项目团队开发规范

修订历史记录

目录 1引言 (6) 1.1 编写目的 (6) 1.2 预期读者 (6) 1.3 编写背景 (6) 2概述 (7) 2.1 目标 (7) 2.2 修改及完善 (7) 3详细规范 (7) 3.1 使用的工具 (7) 3.2 框架设计 (7) 3.3 包目录 (8) 3.4 编码规范 (10) 3.4.1 目的 (10) 3.4.2 依据 (10) 3.4.3 具体规范 (10) 3.4.3.1 编码风格 (10) 3.4.3.1.1 缩进 (10) 3.4.3.1.2 空格 (11) 3.4.3.1.3 对齐 (12) 3.4.3.1.4 空行 (12)

3.4.3.1.5 代码长度 (13) 3.4.3.1.6 行数 (13) 3.4.3.1.7 注释 (14) 3.4.3.2 代码效率 (17) 3.4.3.2.1 综述 (17) 3.4.3.2.2 具体实现 (17) 3.4.3.3 异常处理 (17) 3.4.3.3.1 处理CHECK 异常与UNCHECK异常 (17) 3.4.3.4 程序调试 (17) 3.4.4 日常交流 (18) 3.4.4.1 互相促进 (18)

1引言 1.1 编写目的 本文档作为项目团队开发规范的说明书，描述了项目开发过程中的使用的工具，框架，代码编写规范及注意问题，作为项目团队建设，开发及测试工作的依据。 1.2 预期读者 本文档的预期读者包括以下几类： ?项目组长 ?项目组全体成员 1.3 编写背景 根据公司现有的开发状况，决定组件稳定的项目开发团队，制定全体团队成员共识的开发规范，有助于提高项目开发的效率、项目团队整体水平的提升。

代码开发规范

代码开发规范 1 前言 1.1 为什么需要开发规范 编码规范对于程序员而言尤为重要，有以下几个原因： * 一个软件的生命周期中，80%的花费在于维护 * 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护* 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 * 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 1.2 开发规范的作用 * 减少维护花费 * 提高可读性 * 加快工作交接 * 减少名字增生 * 降低缺陷引入的机会

2 命名规范 2.1 常量命名规范 2.1.1 类型 常量命名规范 2.1.2 说明 常量用于保存需要常驻内存中并且经常使用变化不多的数据，定义常量的名称的时候需要遵循望文知意的原则； 2.1.3 规则 1.全部为大写字母； 2.中间以“_”连接； 3.望文知意原则； 2.1.4 备注 代码中涉及到直接使用某个字符串或者其他基本类型的值时，建议定义成常量，避免多处直接使用同样的值作为参数。 2.1.5 举例 ?如：定义一个常量表示最小屏幕宽度的常量，则可以定义一个int类型的常 量，该常量可以命名为：“MIN_SCREEN_WIDTH“； ?其他举例： ?例如：static final int MIN_SCREEN_WIDTH = 4；( √) ?例如：static final int min_screen_width = 4;（×） ?例如：static final int minScreenWidth = 4; （×） ?例如：static final int WIDTH = 4；（×）

华为Java语言编码规范标准

Java语言编码规范 Prepared by 拟制Date 日期 yyyy-mm-dd Reviewed by 评审人Date 日期 yyyy-mm-dd Approved by 批准Date 日期 yyyy-mm-dd

Revision Record 修订记录

Table of Contents 目录 1. 范围 (4) 2. 规范性引用文件 (4) 3. 术语和定义 (4) 4. 排版规范 (5) 4.1. 规则 (5) 4.2. 建议 (7) 5. 注释规范 (9) 5.1. 规则 (9) 5.2. 建议 (15) 6. 命名规范 (17) 6.1. 规则 (17) 6.2. 建议 (18) 7. 编码规范 (20) 7.1. 规则 (20) 7.2. 建议 (24) 8. JTEST规范 (26) 8.1. 规则 (26) 8.2. 建议 (27)

1.范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。 本规范适用于使用Java语言编程的产品和项目。 2.规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。 3.术语和定义 规则：编程时强制必须遵守的原则。 建议：编程时必须加以考虑的原则。 格式：对此规范格式的说明。 说明：对此规范或建议进行必要的解释。 示例：对此规范或建议从正、反两个方面给出例子。

Java编程规范

Java编程规范本文引用阿里Java开发手册。GitHub阅读地址： 目录 编程规约 - 命名规约 - 常量定义 - 格式规范 - OOP规约 - 集合处理 - 并发处理 - 控制语句 - 注释规约 - 其他 - 异常处理 - 建表规约 - 索引规约 - SQL规约

- ORM规约 编程规约 命名规约 1、【强制】所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束 反例： _name / __name / $Object / name_ / name$ / Object$1 2、【强制】所有编程相关的命名严禁使用拼音与英语混合的方式，更不允许直接使用中的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即纯拼音的命名方式也要避免采用。 反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3; 正例： ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视为英文。12345 3、【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名） DO / DTO / VO / DAO 等。 正例： MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例： macroPolo / UserDo / XMLService / TCPUDPDeal

/ TAPromotion123 4、【强制】方法名、参数名、成员变量、局部变量都统一只用 lowerCamelCase 风格，必须遵从驼峰形式。 正例： localValue / getHttpMessage() / inputUserId1 5、【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 正例： MAX_STOCK_COUNT 反例： MAX_COUNT123 6、【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。 7、【强制】中括号是数组类型的一部分，数组定义如下：String[] args ; 反例：请勿使用 String args[] 的方式来定义1 8、【强制】 POJO 类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。 反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是 isSuccess()， RPC框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。1 9、【强制】包名统一使用小写，点分隔符之间有且仅有一

信息技术有限公司代码开发规范

xx信息技术有限公司代码开发规范 xx信息技术有限公司

代码开发规范 一、项目： IDE统一采用MyEclipse： 1.Tab policy设为“Spaces only”，Indentation size、Tab size均设为4 2.Maximum line width设为：140 3.java文件进行自动格式化 4.项目编码utf-8 二、代码： ?原则 1.数据结构应该只有公共变量；对象应该只有私有变量和公有函数； 2.一个类只做一类事、一个方法只做一件事 3.类、方法尽量简单、短小 4.宽度不超过140个字符 5.方法不超过40行，基本一屏高度 6.类不超过500行 7.尽量用好的命名代替注释 ?基本 1.统一采用log4j代替System.out.print、e.printStackTrace()等打印方式 2.流程语句必须用大括号 3.IO流必须用try finally关闭 ?命名 1.java基本命名规范 2.类为名词、属性为名词、方法为动词(+名词) 3.可以用2代替to，用4代替for，如string2int() 4.命名不许相互包含，如：get()，getOne()

5.不要采用getModel()、getModel1()、getModel2()数字方式命令 ?类型 1.对象属性必须为类，不能用String代替Number、Date等，不能使用基 本类型； 2.方法参数、返回均不许为Map（除非dao层） 3.泛型必须注明类型、不许使用List