java编规范和范例.docx

JAVA 编码规范 JAVA 编码规范  1. 源文件 1.1 文件名 说明：源文件以其最顶层的类名来命名，大小写敏感，文件扩展名为.java。 1.2 文件编码：UTF-8 说明：源文件编码格式为 UTF-8 1.3 源文件结构 说明：一个源文件包含(按顺序地)： 许可证或版权信息(如有需要) package 语句 import 语句 一个顶级类(只有一个) 以上每个部分之间用一个空行隔开 1.3.1 许可证或版权信息 如果一个文件包含许可证或版权信息，那么它应当被放在文件最前面 1.3.2 package 语句 package 语句不换行，即 package 语句写在一行里 1.3.3 import 语句 import 不要使用通配符，即，不要出现类似这样的 import 语句：import java.util.*; import 语句不换行，每个 import 语句独立成行 import 语句可分为以下几组，按照这个顺序，每组由一个空行分隔： 所有的静态导入独立成组 com.google imports(仅当这个源文件是在 com.google 包下) 第三方的包。每个顶级包为一组，字典序。例如：android, com, junit, org, sun java imports 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) { doStart(); } //此处是空行 return; 2.7 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加 空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格 示例： if (a == b) { objectA.doStart(); } a *= 2; 2.8 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置 4 JAVA 编码规范  格式： 类定义 { 类的公有属性定义 类的保护属性定义 类的私有属性定义 类的公有方法定义 类的保护方法定义 类的私有方法定义 } 2.9 修饰词按照指定顺序书写：[访问权限][static][final] 示例： public static final String str = “abc”; 3. 注释 3.1 一般情况下，源程序有效注