学院首页>网络编程>JSP>java编程规范

java编程规范

作者: 来源: 添加时间:2006-5-21 20:56:26
7.4 示例 

7.4.1 块注释: 

主要用来描述文件,类,方法,算法等。一般用在文档和方法的前面,也可以放在文档的任何地方。以‘/*’开头,‘*/’结尾。例: 

…… 

/* 

* 注释 

*/ 

…… 

7.4.2 行注释: 

主要用在方法内部,对代码,变量,流程等进行说明。与块注释格式相似,但是整个注释占据一行。例: 

…… 

/* 注释 */ 

…… 

7.4.3 尾随注释: 

与行注释功能相似,放在代码的同行,但是要与代码之间有足够的空间,便于分清。例: 

int m=4 ; /* 注释 */ 

如果一个程序块内有多个尾随注释,每个注释的缩进应该保持一致。 

7.4.4 行尾注释: 

与行注释功能相似,放在每行的最后,或者占据一行。以‘//’开头。 

7.4.5 文档注释: 

与块注释相似,但是可以被javadoc处理,生成HTML文件。以‘/**’开头,‘*/’结尾。文档注释不能放在方法或程序块内。例: 

/** 

注释 

*/ 



8. 表达式和语句 

8.1 每行应该只有一条语句。 

8.2 if-else,if-elseif语句,任何情况下,都应该有“{”,“}”,格式如下: 

if (condition) { 

statements; 

} else if (condition) { 

statements; 

} else{ 

statements; 



8.3 for语句格式如下: 

for (initialization; condition; update) { 

statements; 



如果语句为空: 

for (initialization; condition; update) ; 

8.4 while语句格式如下: 

while (condition) { 

statements; 



如果语句为空: 

while (condition); 

8.5 do-while语句格式如下: 

do { 

statements; 

} while (condition); 

8.6 switch语句,每个switch里都应包含default子语句,格式如下: 

switch (condition) { 

case ABC: 

statements; 

/* falls through */ 

case DEF: 

statements; 

break; 

case XYZ: 

statements; 

break; 

default: 

statements; 

break; 



8.7 try-catch语句格式如下: 

try { 

statements; 

} catch (ExceptionClass e) { 

statements; 

} finally { 

statements; 



9. 错误处理和异常事件 

通常的思想是只对错误采用异常处理:逻辑和编程错误,设置错误,被破坏的数据,资源耗尽,等等。 

通常的法则是系统在正常状态下以及无重载和硬件失效状态下,不应产生任何异常。异常处理时可以采用适当的日志机制来报告异常,包括异常发生的时刻。不要使用异常实现来控制程序流程结构。 

10. 封装、事务 

1. 非商务公用组件单独封装 

2. 每一个业务流程单独封装 

3. 一次方法(组件)的调用应能完成某一项功能或流程,即符合完整性 

4. 一次方法(组件)的调用符合ACID事务性 

5. 多次方法(组件)的调用应包含在一个事务中 

11. 可移植性 

1. 尽量不要使用已经被标为不赞成使用的类或方法。 

2. 如果需要换行的话,尽量用 println 来代替在字符串中使用"\n"。 

3. 用separator()方法代替路径中的”/”或”\” 。 

4. 用pathSeptarator()方法代替路径中的 ” : ” 或 ” ;” 
第 3 页,共 3 页 [1] [2] [3]
站内搜索