java编码规范v10

JAVA编码规范

目录

JAVA编码规范 (1)

1 概述 (7)

1.1范围 (7)

1.2说明 (7)

2 文件体系结构 (8)

2.1文件体系规则 (8)

规则2.1.1 JSP文件目录结构 (8)

建议2.1.2 Java文件目录结构 (8)

2.2源文件结构规则 (9)

规则2.2.3 类变量的声明顺序是public,protected,package,private (9)

规则2.2.4 变量、常量的注释应放在其上方相邻位置 (9)

规则2.2.5 用递增的方式写构造器（比如：参数多的写在后面） (9)

规则2.2.6 类变量的存取方法：get和set方法 (9)

规则2.2.7 如果定义main() 方法，必须将main方法写在类的底部 (9)

3 文件命名规则 (10)

规则3.1S TRUCTS配置文件命名 (10)

规则3.2JSP文件命名 (10)

规则3.3J AVA文件命名 (10)

4 排版规则 (11)

4.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 “=”等比较符前后加一个空格 (12)

5 注释规则 (13)

5.1类注释规则 (13)

规则5.1.1 使用JavaDoc，列出功能、版本信息、日期、作者和版权声明 (13)

规则5.1.2 如果对文件进行了修改，必须说明修改目的、修改日期、修改人，并变更版本信息 (13)

5.2类方法注释规则 (14)

规则5.2.1 用中文写出每个参数和返回值的含义 (14)

规则5.2.2 当修改其他组员创建的类时，增加@author标签 (14)

5.3单行注释规则 (14)

规则5.4.1单行注释位于所描述内容之前 (14)

规则5.4.2 单行注释之前留一行空行 (14)

5.3.1 接口 (14)

5.3.2 局部变量 (14)

5.3.3 方法 (15)

5.3.4 方法内部注释 (15)

6 命名规则 (16)

6.1包命名规则 (16)

规则6.1.1包的名字全部小写 (16)

6.2类命名规则 (17)

规则6.2.1类名用英文名称，不用汉语拼音。例如Customer，而不是KH (17)

规则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 命名方式采用匈牙利式 (17)

6.3接口命名规则 (17)

规则6.3.1接口的规则与类相同 (17)

规则6.3.2接口名前面加“I” (18)

6.4方法命名规则 (18)

规则6.4.1方法名是动词＋名词对，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写 (18)

建议6.4.2方法名应准确描述方法的功能，不要使用无意义或含义不清的动词为方法命名 (18)

6.5变量命名规则 (18)

规则6.5.1 变量名采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写 (18)

规则6.5.2 除一次性的临时变量（如for循环变量）以外，不能用单个字符的变量名 (18)

规则6.5.3 如果变量名代表容器（collection），如Array, Vector等，在变量名后加“List” (19)

建议6.5.4 变量名要简短且富于描述，能够指出其用途 (19)

建议6.5.5 临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型 (19)

6.6常量命名规则 (19)

规则6.6.1 类常量全部用大写字母，单词间用下划线隔开 (19)

6.7方法的参数命名规则 (19)

规则6.7.1使用全英文命名。首字母小写，后续单词首字母大写 (19)

6.8数组命名规则 (19)

规则6.8.1将[] 放在类型后 (19)

6.9B OOLEAN GETTER 方法命名规则 (20)

规则6.9.1所有布尔型get方法必须用单词”is”作为前缀。”is”为小写，后续单词首字母大写，其余字母小写 (20)

6.10构造方法命名规则 (20)

规则6.12.1 构造方法使用类名 (20)

7 程序日志打印 (21)

规则7.1后台不允许出现SYSOUT控制台打印日志； (21)

规则7.2日志打印类统一采用“MONS.LOGGING.L OG”，不允许使用其它JAR包提供的类似方式； (21)

规则7.3日志级别INFO、ERROR; (21)

规则7.4异常信息的日志打印； (21)

规则8.8引用SPRING配置的BEAN统一采用@注解方式按类型注入 (21)

8 方法 (22)

规则9.1用注释详细说明每个参数的作用、取值范围及参数间的关系 (22)

9 程序效率 (23)

规则11.1不要在循环内执行重复操作 (23)

规则11.2在对字符串有附加操作时，使用S TRING B UFFER而非S TRING。使用S TRING B UFFER性能会好很多 (23)

建议11.3显式地把已经不再被引用的对象赋为NULL (23)

建议11.4不要频繁初始化对象 (23)

10 质量保证 (25)