Java代码规范

Java代码规范

这里是NongFu Spring团队制定的Java代码规范,

基于SUN java标准代码规范进行修改

1.命名规则

1.1标识符

不使用小驼峰法则 为了更好的与方法区分开来
采用下划线区分单词语义
例如
String some_string = "hello";

1.2静态常量

全大写用下划线分割
例如
public static int MAX_INT = 100;

1.3方法名

采用小驼峰法则
例如
void setName() {}

1.4类名

使用大驼峰法则
例如
class FreeTable { }

1.5包名

全使用小写，多单词不分割
“team.团队名.项目名.模块名.……”
“com.公司名.项目名.模块名.……”
例如
team.nongfuspring.calculator.ui

2.代码格式

2.1缩进

用空格字符缩进源代码，不要用tab，每个缩进4个空格。

2.2源文件编码

源文件使用utf-8编码，结尾用windows分格。

2.3行宽

代码每一行的宽度不超过 120

3注释

3.1行块注释

低于5行的代码注释使用行注释
//line1 //line2 //line3 //line4
大于含5行的代码使用块注释
/*line1 line2 line3 line4 line5*/

3.2循环语句

每个if while for等语句，都不要省略大括号{}

3.3使用TODO注释

在代码中加入 //TODO: ，大部分的ide都会帮你提示，让你知道你还有什么事没有做。比如：
if (order.isPaid()) { //TODO: 更新订单 }

3.4使用@注释

对某个名称进行注释
例如
void setName() {} //@setName:设置名字