Java编码约定


优秀的代码胜过冗长的文档。

1. 文件编码
源文件编码格式为UTF-8。

2. 包名使用小写字母

3. import不要使用通配符
即，不要出现类似这样的import语句：import java.util.*;

4. 列长限制
一个项目可以选择一行80个字符或100个字符的列限制，超出列长限制时换行，换行时缩进至少4个空格，缩进不要用tab。

5. 注释
注释应少而精，代码的关键处应该有注释, 注释不能误导读者。

6. 变量声明
每次只声明一个变量，不要使用组合声明，比如int a, b;
需要变量时才声明，并尽快进行初始化。

7. 命名约定
命名应该：见名知意、简洁，避免拼音与英文混用。
命名风格：
类名以UpperCamelCase风格编写
非常量字段名、方法名、参数名、局部变量名以lowerCamelCase风格编写
常量名以CONSTANT_CASE风格编写

8. 类成员顺序
每个类应该以某种逻辑去排序它的成员，维护者应该要能解释这种排序逻辑。比如，新的方法不能总是习惯性地添加到类的结尾。

9. 慎用System.out.println()
使用log而不是System.out.println()


10. 使用大括号(即使是可选的)
大括号与if, else, for, do, while语句一起使用，即使只有一条语句(或是空)，也应该把大括号写上。

11. 减少代码嵌套
代码嵌套层次达3层以上时，一般人理解起来都会困难。
减少嵌套的方法有很多：(1)合并条件；(2)利用return以省略后面的else；(3)使用子方法

12. 异常处理
捕获的异常不能忽视，典型的响应方式是打印日志

本文永久更新链接地址：

相关内容