java编码要求规范v1.0.doc

《java编码要求规范v1.0.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、JAVA编码规目录JAVA编码规11概述71.1围71.2说明72文件体系结构82.1文件体系规则8规则2.1.1JSP文件目录结构8建议2.1.2Java文件目录结构82.2源文件结构规则9规则2.2.3类变量的声明顺序是public,protected,package,private9规则2.2.4变量、常量的注释应放在其上方相邻位置9规则2.2.5用递增的方式写构造器（比如：参数多的写在后面）9规则2.2.6类变量的存取方法：get和set方法9规则2.2.7如果定义main()方法，必须将main方法写在类的底部93文件命名规则

2、10规则3.1Structs配置文件命名10规则3.2JSP文件命名10规则3.3Java文件命名104排版规则114.1语句排版规则11规则4.2.1简单语句每行至多包含一条语句11规则4.2.2复合语句被括其中的语句缩进一个层次11规则4.2.3左大括号"{"应位于复合语句起始行的行尾，前面需加一个空格符；右大括号"}"应另起一行并与复合语句首行对齐。11规则4.2.4必须用"{"和"}"将if的语句括起来。(即使只有一条语句的情况下)11规则4.2.7在多层嵌套的for语句中，应在for上一行增加逻辑注释12建议4.2.14“=”

3、等比较符前后加一个空格125注释规则135.1类注释规则13规则5.1.1使用JavaDoc，列出功能、版本信息、日期、作者和声明13规则5.1.2如果对文件进行了修改，必须说明修改目的、修改日期、修改人，并变更版本信息135.2类方法注释规则14规则5.2.1用中文写出每个参数和返回值的含义14规则5.2.2当修改其他组员创建的类时，增加author标签145.3单行注释规则14规则5.4.1单行注释位于所描述容之前14规则5.4.2单行注释之前留一行空行145.3.1接口145.3.2局部变量145.3.3方法155.3.4方法部注

4、释156命名规则166.1包命名规则16规则6.1.1包的名字全部小写166.2类命名规则17规则6.2.1类名用英文名称，不用汉语拼音。例如Customer，而不是KH17规则6.2.2类名是名词，采用大小写混合的方式，每个单词的首字母大写17规则6.2.3类名不要用复数17规则6.2.4类名不要以“A”，“An”或“The”开头17规则6.2.5如果不能选择适当的类名，而该类与数据库一个表紧密相关，再把数据库表名作为类名17规则6.2.6使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML)17规则6.2.7命名方

5、式采用匈牙利式176.3接口命名规则17规则6.3.1接口的规则与类相同17规则6.3.2接口名前面加“I”186.4方法命名规则18规则6.4.1方法名是动词＋名词对，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写18建议6.4.2方法名应准确描述方法的功能，不要使用无意义或含义不清的动词为方法命名186.5变量命名规则18规则6.5.1变量名采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写18规则6.5.2除一次性的临时变量（如for循环变量）以外，不能用单个字符的变量名18规则6.5.3如果变

6、量名代表容器（collection），如Array,Vector等，在变量名后加“List”19建议6.5.4变量名要简短且富于描述，能够指出其用途19建议6.5.5临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型196.6常量命名规则19规则6.6.1类常量全部用大写字母，单词间用下划线隔开196.7方法的参数命名规则19规则6.7.1使用全英文命名。首字母小写，后续单词首字母大写196.8数组命名规则19规则6.8.1将[]放在类型后196.9Booleangetter方法命名规则20规则6.

7、9.1所有布尔型get方法必须用单词”is”作为前缀。”is”为小写，后续单词首字母大写，其余字母小写206.10构造方法命名规则20规则6.12.1构造方法使用类名207程序日志打印21规则7.1后台不允许出现sysout控制台打印日志；21规则7.2日志打印类统一采用“org.apache.commons.logging.Log”，不允许使用其它jar包提供的类似方式；21规则7.3日志级别INFO、ERROR;21规则7.4异常信息的日志打印；21规则8.8引用SPRING配置的bean统一采用注解方式按类型注入218方法22规则

8、9.1用注释详细说明每个参数的作用、取值围及参数间的关系229程序效率23规则11.1不要在循环执行重复操作23规则11.2在对字符串有附加操作时，使用StringBuffer而非String。使用Stri