- 1、本文档共21页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
Java编程规范和范例.pdf
JAVA 编码规范
JAVA 编码规范
1. 源文件
1.1 文件名
说明:源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。
1.2 文件编码:UTF-8
说明:源文件编码格式为UTF-8
1.3 源文件结构
说明:一个源文件包含(按顺序地):
1. 许可证或版权信息(如有需要)
2. package 语句
3. import 语句
4. 一个顶级类(只有一个)
以上每个部分之间用一个空行隔开
1.3.1 许可证或版权信息
如果一个文件包含许可证或版权信息,那么它应当被放在文件最前面
1.3.2 package 语句
package 语句不换行,即package 语句写在一行里
1.3.3 import 语句
import 不要使用通配符,即,不要出现类似这样的import 语句:import java.util.*;
import 语句不换行,每个import 语句独立成行
import 语句可分为以下几组,按照这个顺序,每组由一个空行分隔:
1. 所有的静态导入独立成组
2. com.google imports(仅当这个源文件是在com.google 包下)
3. 第三方的包。每个顶级包为一组,字典序。例如:android, com, junit, org, sun
4. java imports
5. javax imports
组内不空行,按字典序排列。
2
JAVA 编码规范
2. 排版
2.1 程序块要采用缩进风格编写,缩进的空格数为4 个,不允许使用TAB 缩进
说明:对于由开发工具自动生成的代码可以有不一致。
2.2 使用大括号(即使是可选的)
大括号与if, else, for, do, while 语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。
对于非空块和块状结构,大括号遵循Kernighan 和Ritchie 风格(Egyptian brackets):
左大括号前不换行
左大括号后换行
右大括号前换行
如果右大括号是一个语句、函数体或类的终止,则右大括号后换行; 否则不换行。例如,如果右大
括号后面是else 或逗号,则不换行。
示例:
return new MyClass() {
@Override public void method() {
if (condition()) {
try {
something();
} catch (ProblemException e) {
recover();
}
}
}
};
2.3 较长的语句, 建议分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,
划分出的新行要使用8 个空格的缩进 ,使排版整齐,语句可读
示例:
if ( logger.isDebugEnabled() ) {
logger.debug(Session destroyed,call-id
+ event.getSession().getCallId());
}
2.4 不允许把多个短语句写在一行中,即一行只写一条语句
示例:如下例子不符合规范
Object o = new Object(); Object b = null;
3
JAVA 编码规范
应如下书写
Object o = new Object();
Object b = null;
2.5 if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while,switch 等语句的执行
语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}
示例:
if (a b) {
doStart();
}
case x: {
int i = 9;
}
2.6 相对独立的程序块之间、变量说明之后必须加空行
示例:
if (a b) {
doSta
文档评论(0)