当前位置:文档之家› JAVA技术开发标准

JAVA技术开发标准

JAVA技术开发标准
JAVA技术开发标准

(一)注释规则

注释应该增加代码的清晰度,注释出谁在什么时候为什么做了一些事,而不仅仅是做了什么。尽量使用javadoc标志,为类生成文档。

Java中有三种注释方法:单行注释符(//),块注释符(/* /)和文档注释(/** */)

(1)单行注释符(//)

//注释符用来对一行代码添加说明型描述,常见使用如下:

a.变量注释,对变量的定义做出说明,不同的行之间要对齐,如下

int level; // indentation level

int size; // size of table

b.添加在一行代码结尾或一段代码开始用于对代码进行描述

if (foo > 1) {

// Do a double-flip.

...

}

else{

return false; // Explain why here.

}

(2)块注释符(/* */)

用于注释一段代码或添加多行说明,如:

/*

* Here is a block comment.

* Comment continues…

* 如果该文件不是修改人创建的,还需要添加修改人,时间等信息

*/

(3)文档注释(/** */)

文档注释使用/**开头,在使用javadoc对java代码制作文当时会自动将代码中的文档注释添加到文档中去。在所有class开头和每个方法前都应该加上/**…*/注释,便于自动生成html格式的类库指南。(包括但不限于beans,action,form,dao)

对于class的文档注释应该写在class申明语句前,并且拥有如下格式:

/**

*

Title: 续期收费请求对象

*

Description: 封装页面提交的请求数据

*

Copyright: Copyright (c) 2002

*

Company: Co., Ltd.

* @since 2008-08-20

* @author Kevin Qiu

* @version 1.0

*/

public class RenewChargeRO {}

(4)方法注释

/**

* 查询续期应收费用列表:查询指定保单号码保单的续期应收费用信息,

* 如果是修改,还应注明修改人及修改时间

* @param sPolicyCode 保单号码

* @return Collection of RenewChargeVO 应收费用信息列表

* @throws Exception 所有发生可能的异常

*/

public Collection getRenewChargeList(String sPolicyCode) throws Exception;

注释开始是对方法的描述。Param是对参数的描述,return是返回类型的描述,throws是对抛出异常的描述。

严格按照文档注释的规范写出完整的注释后,程序生成的HTML类库指南就很详细,方便其他使用该类的程序员查阅和使用。

(二)BEANS定义规范

1、字段名称的取法符合规范,详细情况以数据字典为准,一般采用英文去掉元音后的三字母简写,

例如,code,简写cde;name简写nme;department简写 dpt;年月简写ptyear,ptmnth,金额简写orgamt,occamt,accamt;日期简写 ptdate,occdat,effdat,strdat,endate等。

2、String类型必须定义适当的长度;Double、Float类型必须定义适当的长度及精度

@Column(nullable = true,length =10) ,如果是长文档备注类型,直接定义为@Lob类型

@Column(nullable = true,precision=14, scale=2)

3、可以为列建唯一索引,如下所示

@Column(nullable = true,length =15,unique=true)

columnDefinition,为列设定默认值

4、按适当的情况定义主键及复合索引等

@Table(name="sys_clnt",uniqueConstraints={@UniqueConstraint(columnNames={"clntid","simpname"})})

定义本Beans的主键,主键可以是Integer,String,Date等类型

@Id

@TableGenerator(name = "SId", table = "sysid", pkColumnName = "id", valueColumnName = "tableid", pkColumnValue = "5", allocationSize = 1, initialValue = 10000000)

@GeneratedValue(strategy = GenerationType.TABLE, generator = "SId")

@Column(nullable = false,length =10)

private String usercode;

5、每个定段必须要用行注释“//”的形式来说明字段的意义,每行注释必须对齐,说明必须清晰,如果该字段内容来自于SysItem,则需在注释中说明ITEMID键值等。

6、在定义中,我们使用的类型仅为String、Double、Integer、Date、Long型,不使用其它类型(在保险相关的项目中,所有的日期型均使用Date型,其它类型项目使用Long型)。

(三)JSP或HTML页面规范

1、下拉列表需要使用

框起来。

2、标识为必需录入框的语句为*,该标识放置于录入框的后面。

3、如何格式化数字,

4、一般中文或是字符串要求左对齐;定长数据可以居中(如固定长度日期,固定长度订单号,固

定长度身份证,定长代码等),数字要求右对齐(后面再放置“   ”占位),且必须格式化,如"#,##0.00"这种,单价/金额/发票/一般保留二位,重量与常规的数量保留整数。

5、页面上所有的录入框、下拉列表等,必须使用适当的clsass或StyleClass类型,控件的长度

一般一致,每行三列数据项的方式排列。

6、Jsp或是Html文件名首字母必须大写。

7、Jsp中使用TABLE时,其中的、要有缩进及对齐。

8、对action中返回到Jsp的List->objs,除了能直接使用对象的外,一律使用数组的方式实现输

出,如下所示:

${objs[0]}-${objs[1]}

${objs[2]}

${objs[3]}

9、jsp/java中不得有任何引起警告的代码。

10、在任何一个JSP中,对JSP的BODY使用如下样式,支持按回车跳下一个控件

11、在JSP中,如果以按钮提交的方式来定义提交对应的类型,通用方法强制用以下方法命名

保存:

编辑:

删除:

查询:

12、在JSP中,如果以activeType的方式来定义提交类型,通用方法强制用以下代码表示:

保存:

编辑:

删除:

查询:

13、对于有CODE及NAME形式显示的资料,在页面上一律使用CODE-NAME的形式显示给用户。

14、查询及报表

保证所有查询条件的有效性;汇总及明细一致性,查询结果及报表输出的一致性;不同查询或是报表的结果一致性,页面常见功能的有效性。

无论何种情况,如果报表与查询需求并非一致,不能放在同一页面中。

任何报表,必须先有查询及JSP List,才能有打印。

报表的风格要求:按公司报表模板执行。

(四)JAVA编程规范

1、通用命名规范

2、action & form中的特殊命名要求:

a. ActionMappin命名为mapping;ActionForm命名为pForm;HttpServletRequest命名为req;HttpServletResponse命名为res;

b.Action中用于拼装SQL条件的StringBuffer变量一律命名为hql或sql,如果需要二个以上,则是hql0/sql0、hql1/sql1、hql2/sql2……

3、所有分页查询的action一律使用getList或getListBySQL这二个函数完成,如果使用这二个函数,引用方法一律为DAO.getList……的形式。

a、特殊情况下,使用executeSQLQuery或executeQuery获取数据,则需在action中添加代码

if(pForm.getRowsPerPage()!=0)

page.setRowsPerPage(pForm.getRowsPerPage());

4、对数据库中选出的分页记录中的Long型日期,在action中直接转化为页面需要的”yyyy-MM-dd”类型,不建议使用数据库的函数完成转换,因为不能使用程序通用化,参考以下代码:SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");

int i=0;

for(Iterator it = page.getList().iterator();it.hasNext();){

Object[] si = (Object[])it.next();

si[5]=(si[5]!=null?df.format(new Date(Long.valueOf(si[5].toString()))):"");

page.getList().set(i, si);

i++;

}

5、所有的方法必须有方法注释,详见前面的格式;如果程序超过200行左右的代码,应该分为不同的方法或是函数,维护程序的可读性。

6、任何JAVA代码中不能有引起警告状态;对不得不使用而导致的情况按以下方法进行处理。

@SuppressWarnings("deprecation")

@SuppressWarnings("unchecked ")

@SuppressWarnings({"deprecation", "unchecked"})

7、常规程序要求:事务提交的一致性及错误回滚要求;程序功能流转保证正确,相关数据准确无误,含各种验证及错误处理,不能有应用服务器的报告错误页面出现

8、代码缩排规则

(1)同行的代码缩排的间距一般定为4个空格,Tab键一般设为4个空格。

(2)行代码或注释的长度尽量少于80个字符,如果一行代码过长,应该换行。

(3)逗号后加空格后再写其他代码,在每个运算符前后也都要留有空格。

(4)长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

(5)表达式在换行时应该首先考虑在优先级高的运算符处换行,新行的开始位置应该和原先行的相应字符对齐。如:

longName1 = longName2 * (longName3 + longName4

- longName5) + 4 * longname6;

应该写成

longName1 = longName2 * (longName3 + longName4 - longName5)

+ 4 * longname6;

例如SQL拼装式例,每个字段分一行,”,”放在字段的前面,如下所示。

sql.append("select orgcode" +

",organizename" +

",ptyear" +

",ptmnth," +

",ab");

(6)对独立的程序块之间、变量说明之后必须加空行。

(7)函数或过程中的参数较长,则要进行适当的划分。

(8)不允许把多个短语句写在一行中,即一行只能写一条语句。

(9)if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while 等语句的执行语句部分无论多少都要加括号{}。

(10)对齐只使用TAB,不使用空格键。

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)

Java编程规范试题

姓名: ____________ 工号:_______________ 部门:____________ 成绩: 一. 判断题(共15题,每题2分,直接在括号内打“/或“X”) 1、任何时候都不要使接口可以序列化。x 2、相对独立的程序块之间、变量说明之后必须加空行。V 3、当程序需要释放对象的时候,应该手工调用fin alize 方法以释放对象。x 4、公司的规范要求注释率是20%以上,并且必须有助于对程序的阅读理解。x 5、为了程序更加简洁,我们应该尽量使用下面的方式来赋值: a = b = 1 。x 6、每个类都需要定义构建器。x 7、类名、方法名、属性名的命名,都应该使用意义完整的英文描述。V 8、main() 方法的定义是public static void main(String args[]) 。x 9、常量名应该使用全大写,英文单词之间用下划线或者-分隔开。并且,常量应该使用final static 修饰。x 10、公有方法参数名可以和属性名相同,但局部变量不能和属性名相同。V 11、一两行代码就能完成的功能没有必要编写方法实现。x 12、对于模块间接口方法的参数的合法性检查,调用者和被调用者都应该对参数进行合法性检查。 x 13、运行期异常使用RuntimeException的子类来表示,必须在方法声明上加throws子句。x非运行 期异常是从Exception继承而来的,不用在可能抛出异常的方法声明上加throws子句。x 14、使用Objectstream 的方法后,调用release(),释放对象。X 15、减小单个方法的复杂度,使用的if, while, for, switch 语句要在10个以内。V 二、单项选择题(共23题,每题2分) (c ) 1、排版时,代码缩进应该采用的方式是: (A)Tab缩进 (B)2个空格缩进

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页面命名 对于某个功能块的增删改查页面定义,最好使用

软件系统JAVA开发编码规范V1.0

软件系统JAVA 编码规范 版本V1.0

文档信息: 内容范围: 本文档是软件系统JAVA编码规范。适用的对象: 公司相关技术人员。

目录 1 介绍(INTRODUCTION) (5) 2 2 文件名(FILE NAMES) (6) 2.1文件后缀(F ILE S UFFIXES) (6) 2.2常用文件名(C OMMON F ILE N AMES) (6) 3 文件组织(FILE ORGANIZATION) (7) 3.1J AVA源文件(J AVA S OURCE F ILES) (7) 3.1.1开首注释(B EGINNING C OMMENTS) (7) 3.1.2包和引入语句(P ACKAGE AND I MPORT S TATEMENTS) (8) 3.1.3类和接口声明(C LASS AND I NTERFACE D ECLARATIONS) (8) 4 缩进排版(INDENTATION) (9) 4.1行长度(L INE L ENGTH) (9) 4.2换行(W RAPPING L INES) (9) 5 注释(COMMENTS) (13) 5.1实现注释的格局(I MPLEMENTATION C OMMENT F ORMATS) (13) 5.1.1块注释(B LOCK C OMMENTS) (13) 5.1.2单行注释(S INGLE-L INE C OMMENTS) (14) 5.1.3尾端注释(T RAILING C OMMENTS) (15) 5.1.4行末注释(E ND-O F-L INE C OMMENTS) (15) 5.2文档注释(D OCUMENTATION C OMMENTS) (16) 6 声明(DECLARATIONS) (17) 6.1每行声明变量的数量(N UMBER P ER L INE) (17) 6.2初始化(I NITIALIZATION) (17) 6.3布局(P LACEMENT) (17) 6.4类和接口的声明(C LASS AND I NTERFACE D ECLARATIONS) (18) 7 语句(STATEMENTS) (20) 7.1简单语句(S IMPLE S TATEMENTS) (20) 7.2复合语句(C OMPOUND S TATEMENTS) (20)

JAVA开发规范

1.编程规范 (一)命名规范 1.【强制】所有编程相关的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束 反例:_name / name_ / $name / name$ 正例:name 2.【强制】所有编程相关的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。 反例:XingMing [姓名] /xingBie() [性别] 正例:name[姓名] sex[性别]等国际通用的名称,可视为英文。 3. 【强制】类名使用UpperCamelCase(第一个词的首字母,以及后面每个词的首字母都大写,叫做“大骆驼拼写法”) 风格,必须遵从驼峰形式,但以下情形例外:(领域模型的相关命名)DO / DTO / VO / DAO 等。正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

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

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 编写背景 根据公司现有的开发状况,决定组件稳定的项目开发团队,制定全体团队成员共识的开发规范,有助于提高项目开发的效率、项目团队整体水平的提升。

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、【强制】包名统一使用小写,点分隔符之间有且仅有一

Java编程要求规范精彩试题

JAVA编程规范--试题 姓名:工号:部门:成绩: 一. 判断题(共15题,每题2分,直接在括号内打“√”或“×”) 1、任何时候都不要使接口可以序列化。x 2、相对独立的程序块之间、变量说明之后必须加空行。√ 3、当程序需要释放对象的时候,应该手工调用finalize方法以释放对象。x 4、公司的规范要求注释率是20%以上,并且必须有助于对程序的阅读理解。x 5、为了程序更加简洁,我们应该尽量使用下面的方式来赋值:a = b = 1 。x 6、每个类都需要定义构建器。x 7、类名、方法名、属性名的命名,都应该使用意义完整的英文描述。√ 8、main() 方法的定义是public static void main(String args[])。x 9、常量名应该使用全大写,英文单词之间用下划线或者-分隔开。并且,常量应该使用 final static修饰。x 10、公有方法参数名可以和属性名相同,但局部变量不能和属性名相同。√ 11、一两行代码就能完成的功能没有必要编写方法实现。x 12、对于模块间接口方法的参数的合法性检查,调用者和被调用者都应该对参数进行合 法性检查。x 13、运行期异常使用RuntimeException的子类来表示,必须在方法声明上加throws子句。 x非运行期异常是从Exception继承而来的,不用在可能抛出异常的方法声明上加throws 子句。x 14、使用ObjectStream 的方法后,调用release() ,释放对象。X 15、减小单个方法的复杂度,使用的 if, while, for, switch 语句要在10个以内。√ 二、单项选择题(共23题,每题2分) ( c )1、排版时,代码缩进应该采用的方式是: (A)Tab缩进 (B)2个空格缩进 (C)4个空格缩进 (D)8个空格缩进

java开发规范文档

一千零一夜产品部系统开发规范V1.0 一千零一夜途遇科技有限公司 2015-11-03

修改记录 目录 1前言 (4) 2开发管理 (4) 3项目周期 (4) 4命名规范 (5) 4.1项目编号命名规范 (5) 4.2文档命名规范 (5) 4.3路径管理 (5) 4.4jsp/html命名规范 (6) 4.5数据库命名规范 (8) 4.5.1表名规范 (8) 4.5.2字段规范 (8) 5文档规范 (8) 6代码规范 (9) 6.1Java源代码规范 (9) 6.1.1命名 (9) 6.1.2代码格式 (11) 6.1.3注释 (12) 6.1.4其他 (13) 6.2jsp/html代码规范 (13) 6.3数据库开发规范 (15) 6.3.1主键 (15) 6.3.2日期类型 (16) 6.3.3固定字段 (16) 6.3.4取值规范 (16) 6.3.5数据库开发工具 (16)

6.3.6Sql书写规范 (17) 6.4其他规范 (17) 7实战代码规范 (18) 7.1Java源代码规范 (18) 7.1.1java代码命名与格式 (18) 7.2jsp/html代码规范 (26) 8FAQ (29) 8.1Logic类中新增数据方法怎么写 (29) 8.2Logic类中修改数据方法怎么写 (30) 8.3Logic类中删除数据方法怎么写 (31) 8.4怎样创建一个没有底部按钮的窗口 (32) 8.5怎样设置弹出窗口的标题 (32) 8.6怎样重写提交数据的方法 (33) 8.7怎样创建单grid的页面 (33) 8.8怎样多个页签的grid的页面 (34) 8.9怎样创建左边树右边grid的页面 (34) 9代码检查规定 (34) 10附录1:JPA使用指南javax.persistence的注解配置 (34)

javaweb开发规范

Java web开发规范 1、前言 为了使软件开发过程有章可循,保证软件质量,加强开发管理。 2、开发管理 项目进度周报表格如下: 项目编号汇报人汇报日期项目进度详细描述其他问题 3、命名规范 3.1项目编号命名规范 命名方式:项目英文/中午拼音名称_开发组编号_序列号 序列号由3为数字组成,不足的用’0’补齐。 3.2文档命名规范 命名方式:项目英文/中午拼音名称_文档名称_序列号_编写人名称/编号 3.3jsp/html命名规范 1、jsp与html文件名全部小写,并遵循如下的规范: a.数据/内容显示页: 名词,多个单词用下划线分隔,要求能说明显示内容的信息,为避免冲突,可加上“_list”。例如: new_message.html或my_file_list.jsp b.操作处理页 命名格式:名词_下划线_动词,例如:file_delete.jsp。 c.含frame页面

中的name属性命名的格式是①xxx_②xxx_③xxx ①xxx部分用来标识当前页面隶属于整个系统中的哪一功能模块。 如:属于ebwebmail模块则写ebwebmail,其它情况依次类推。 ②xxx部分标识当前页面所要完成的功能。 如:完成用户登录的功能则被标识为login,其它情况依次类推。 ③xxx部分用来用来表示页面在浏览器窗口所处的位置。 处于浏览器窗口的顶部则标识为top,其它情况依次类推。 例如:ebwebmail_inbox_top.jsp src属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置。 2、javascript脚本文件命名方式: 脚本函数都以①xxx_②xxx的方式命名。 ①xxx对应页面隶属的模块。 ②xxx表示函数所要实现的功能(动宾结构),多个单词用下划线连接。 例如:ebwebmail_send_mail() 模块通用的脚本函数必须集合于一个js文件中,在页面上通过形式导入。js文件名命名使用模块名,例如:ebwebmail.js。 如果项目已经提供了公共js脚本,则优先使用公共js脚本中提供的函数。 所有定义方法的