JAVA 代码基础规范汇总

 

1.命名规范   

（1）所有的标识符都只能用字母、数字、划线“_”及“$”，不能使用Java关键字。

 

（2）包名通常全部是小写的字母。例如：mypackage

 

（3）类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。例如：HelloWorld。

 

（4）定义类名、方法名、变量名时不能包含空格、+符号。

 

（5）方法名是一个动词或动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。例如：getName(String Name)。

 

（6）变量名第一个字母小写，任何中间单词的首字母大写。变量名应简短且可以顾名思义，易于记忆。例如：myName、myAddress。避免单个字符的变量名，除非是一次性的临时变量。

 

（7）常量的声明应该全部大写，每个单词之间用“_”连接。例如：final String  MY_NAME = "chosen";

 

2.注释规范

 

（1）注释尽可能使用“//”；

（2）所有的源文件都应该在开头有一个注释，其中列出文件名、日期和类的功能概述。

 

（3）每个方法必须添加文档注释（类的main()方法除外）。

 

（4）每个属性必须添加注释。

 

（5）代码中至少包含15%的注释。

3.文件名规范

 

（1）一个Java源文件只能存储一个Java类。

 

（2）文件名与Java类名相同。

 

（3）一个类文件的代码行不超过200行。

 

4.声明规范

 

（1）一行声明一个变量。

 

（2）不要将不同类型变量的声明放在同一行。

 

（3）只在代码块的开始处声明变量。

 

（4）所有的变量必须在声明时初始化。

 

（5）避免声明的局部变量覆盖上一级声明的变量。

 

（6）方法与方法之间以空行分隔。

 

5.语句规范

 

（1）同一级代码对齐，运算符前后有空格。

 

（2）在return语句中，返回值不使用小括号“()”括起来；

 

（3）if语句总是用“{”和“}”括起来。

（4）在for语句的初始化或更新子句中，避免因使用三个以上变量，而导致复杂度提高。

 

（5）当switch的一个case顺着往下执行时（因为没有break语句），通常应在break语句的位置添加注释。

 

6.编程规范

 

（1）提供对实例以及类变量的public或private访问控制，尽可能不适用默认值或protected访问控制。

 

（2）避免用一个对象访问一个类的静态变量或方法。应该用类名代替。逻辑抽取出来放在单独的方法里。

 

（3）避免在一个语句中给多个变量赋相同的值。

 

（4）有些程序必须做要做参数校验。程序有外来用户输入给我们系统的参数。

 

（5）如果使用JDBC，则考虑使用java.sql.PreparedStatement，而不是java.sql.Statement。

 

（6）用于设置对象状态的方法前缀必须是set；用于检索一个布尔类型对象状态的方法前缀必须是is，而用于检索其他方法前缀必须是get。

 

（7）程序中应尽可能少使用数字（或字符），尽可能定义静态变量来说明该数字（或字符）的含义。程序中需要赋值或比较时，使用前面定义的静态变量。在循环控制中例外。