java编码规范v1.0.docx

JAVA编码规范
目录
JAVA编码规范 1
1 概述 7
范围 7
说明 7
2 文件体系结构 8
文件体系规则 8
JSP文件目录结构 8
Java文件目录结构 8
源文件结构规则 9
类变量的声明顺序是public,protected,package,private 9
变量、常量的注释应放在其上方相邻位置 9
用递增的方式写构造器(比如:参数多的写在后面) 9
类变量的存取方法:get和set方法 9
如果定义main() 方法,必须将main方法写在类的底部 9
3 文件命名规则 10
Structs配置文件命名 10
JSP文件命名 10
Java文件命名 10
4 排版规则 11
语句排版规则 11
11
复合语句被括其中的语句缩进一个层次 11
左大括号"{"应位于复合语句起始行的行尾,前面需加一个空格符;右大括号"}"应另起一行并与复合语句首行对齐。 11
必须用"{"和"}"将if内的语句括起来。(即使只有一条语句的情况下) 11
在多层嵌套的for语句中,应在for上一行增加逻辑注释 12
“=”等比较符前后加一个空格 12
5 注释规则 13
类注释规则 13
使用JavaDoc,列出功能、版本信息、日期、作者和版权声明 13
如果对文件进行了修改,必须说明修改目的、修改日期、修改人,并变更版本信息 13
类方法注释规则 14
用中文写出每个参数和返回值的含义 14
当修改其他组员创建的类时,增加***@author标签 14
单行注释规则 14
14
单行注释之前留一行空行 14
接口 14
局部变量 14
方法 15
方法内部注释 15
6 命名规则 16
包命名规则 16
16
类命名规则 17
,不用汉语拼音。例如Customer,而不是KH 17
,采用大小写混合的方式,每个单词的首字母大写 17
17
“A”,“An”或“The”开头 17
,而该类与数据库一个表紧密相关,再把数据库表名作为类名 17
,避免缩写词(除非该缩写词被更广泛使用,像URL,HTML) 17
命名方式采用匈牙利式 17
接口命名规则 17
17
“I” 18
方法命名规则 18
+名词对,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写 18
,不要使用无意义或含义不清的动词为方法命名 18
变量命名规则 18
变量名采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写 18
除一次性的临时变量(如for循环变量)以外,不能用单个字符的变量名 18
如果变量名代表容器(collection),如Array, Vector等,在变量名后加“List” 19
变量名要简短且富于描述,能够指出其用途 19
临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型 19
常量命名规则 19
类常量全部用大写字母,单词间用下划线隔开 19
方法的参数命名规则 19
。首字母小写,后续单词首字母大写 19
数组命名规则 19
[] 放在类型后 19
Boolean getter 方法命名规则 20
”is”作为前缀。”is”为小写,后续单词首字母大写,其余字母小写 20
构造方法命名规则 20
构造方法使用类名