Java系统代码开发规范.doc
文本预览下载声明
Java系统代码开发规范
1:Java 编程规范
1.1 排版
规则1?该缩进的时候一定要有缩进(主要是开始一个新的语句块的时候),缩进的空格数为4个,最好不要使用TAB缩进。
规则2 分界符(如大括号“{?和”}?)要占据正整行,同时与引用它们的语句左对齐。在函数体 的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static,synchronized等语句块中都要采用如上的缩进方式。
例如:
If (条件一)
{
语句1;
}
规则3 较长的语句要分成多行书写,一行最好不要超过80个字符,在操作符处划分新行,如果有多个操作符,选择低优先级操作符号。
例如If(log.debugenabled())
{
Log.debug(“dasdfasdfasdfasdfasd”
+”asdfasdfasdfasdfasdfasdf”)
}
规则4 始终遵守一行只写一条语句的规定,
示例:如下例子不符合规范。 Object o = new Object(); Object b = null;
规则5 if, for, do, while, case, switch, default 等语句自占一行,
且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。
规则6 在一个比较大的函数中,相对独立的程序块之间,必须加空行。
规则7 类文件的内容排版遵循以下规则。
类属性和类方法不要交叉排版,
类的排版格式建议如下:
类定义
{
类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
类的保护方法定义
类的私有方法定义
}
1.2 注释
1.2.1 规则
规则1 包的注释:写入一个名为?package.html?的HTML格式的说明文件放入包所在路径。包的注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公
司版权。这个注释需要提供给javadoc进行收集,可以描述包的信息。
格式如下:
html?
body?
p一句话简述。?
p详细描述。?
p产品模块名称和版本?
br公司版权信息?
/body?
/html
规则2 类和接口的注释:类和接口的注释放在class 或者 interface 关键字之前一行。注释必须使用符合javadoc格式的“/** */”注释版本,注释主要分为一句话功能简述加上功能详细描述。
下面就是注释的建议格式:
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @author [作者](必须)
* @see [相关类/方法](可选)
* @since [产品/模块版本] (必须)
* @deprecated (可选)
* Modification History:
* Date Author Version Description
* -----------------------------------------------------------------
* 2014-5-27 [zhujihua] v1.0.0 create
*/
示例:
package com.travelsky.modul1.demoService;
import java.util.*;
/**
* LogManager 类集中控制对日志读写的操作。
* 全部为静态变量和静态方法,对外提供统一接口。分配对应日志类型的读写器,
* 读取或写入符合条件的日志纪录。
* @author 张三,李四,王五
* @see LogIteraotor
* @see BasicLog
* @since
*/
Public class LogManager
规则3 公有和保护方法注释内容:列出方法的一句话功能简述、功能详细描述、输入参数、 输出参数、返回值、异常等。
建议格式:
/**?
?
*?〈一句话功能简述〉??
*?〈功能详细描述〉?
?
*?@param?[参数1]?????[参数1说明]??
*?@param?[参数2]?????[参数2说明]??
*?@return??[返回类型说明]?
?
*?@exception/throws?[异常类型]?[异常说明]??
*?@see???[类、类#方法、类#成员
显示全部