没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论








1 Java 编程规范
1.1 排版
1.1.1 规则
规则1 程序块要采用缩进风格编写,缩进的空格数为4个,不允许使用TAB缩进。(1.42+)
说明:缩进使程序更易阅读,使用空格缩进可以适应不同操作系统与不同开发工具。
规则2 分界符(如大括号‘{’和‘}’)应各独占一行,同时与引用它们的语句左对齐。在函数体
的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程
序或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+)
示例:
if (a>b)
{
doStart();
}
规则3 较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作
符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,
语句可读。(1.42+)
示例:
if (logger.isDebugEnabled())
{
logger.debug("Session destroyed,call-id"
+ event.getSession().getCallId());
}
规则4 不允许把多个短语句写在一行中,即一行只写一条语句(1.42+)
说明:阅读代码更加清晰
示例:如下例子不符合规范。
Object o = new Object(); Object b = null;
规则5 if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while,switch等语句
的执行语句无论多少都要加括号 {},case 的执行语句中如果定义变量必须加括号 {}。
(1.42+)
说明:阅读代码更加清晰,减少错误产生
示例:
if (a>b)
{
doStart();
}

密级:内部公开
case x:
{
int i = 9;
}
规则6 相对独立的程序块之间、变量说明之后必须加空行。 (1.42+)
说明:阅读代码更加清晰
示例:
if(a > b)
{
doStart();
}
//此处是空行
return;
规则7 在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者
前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如 .),后不应加
空格。(1.42+)
说明:阅读代码更加清晰
示例:
if (a == b)
{
objectA.doStart();
}
a *= 2;
1.1.2 建议
建议1 类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。
(1.42+)
格式:
类定义
{
类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
类的保护方法定义
Page 2 , Total 18

密级:内部公开
类的私有方法定义
}
建议2 修饰词按照指定顺序书写:[访问权限][static][final] 。(1.42+)
示例:
public static final String str = “abc”;
1.2 注释
1.2.1 规则
规则1 源程序注释量必须在30%以上。(1.42+)
说明:由于每个文件的代码注释不一定都可以达到30%,建议以一个系统内部模块作为单位进
行检查
规则2 包的注释:写入一个名为 package.html 的HTML格式的说明文件放入包所在路径。包的
注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、
公司版权。(1.42+)
说明:方便JavaDoc收集,方便对包的了解
示例:
com/huawei/iin/websmap/comm/package.html
<html>
<body>
<p>一句话简述。
<p>详细描述。
<p>产品模块名称和版本
<br>公司版权信息
</body>
</html>
示例:
<html>
<body>
<P>为 WEBSMAP 提供通信类,上层业务使用本包的通信类与 SMP-B 进行通信。
<p>详细描述。。。。。。。。
<p>IIN V100R001 WEBSMAP
<br>(C) 版权所有 2000-2001 华为技术有限公司
</body>
</html>
规则3 类和接口的注释放在class 或者 interface 关键字之前,import 关键字之后。
注释主要是一句话功能简述与功能详细描述。类注释使用“/** */”注释方式(1.42+)
Page 3 , Total 18

密级:内部公开
说明:方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出:作者、内容、功
能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意
事项,每次修改后增加作者和更新版本号和日期,@since 表示从那个版本开始就有这个类
或者接口,@deprecated 表示不建议使用该类或者接口。
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @author [作者](必须)
* @see [相关类/方法](可选)
* @since [产品/模块版本] (必须)
* @deprecated (可选)
*/
示例:
package com.huawei.iin.logwebsmap.comm;
import java.util.*;
/**
* LogManager 类集中控制对日志读写的操作。
* 全部为静态变量和静态方法,对外提供统一接口。分配对应日志类型的读写器,
* 读取或写入符合条件的日志纪录。
* @author 张三,李四,王五
* @see LogIteraotor
* @see BasicLog
* @since CommonLog1.0
*/
public class LogManager
规则4 类属性(成员变量)、公有和保护方法注释:写在类属性、公有和保护方法上面,注释方
式为“/** */”.(1.42+)
示例:
/**
* 注释内容
*/
private String logType;
/**
* 注释内容
*/
public void write()
规则5 公有和保护方法注释内容:列出方法的一句话功能简述、功能详细描述、输入参数、
输出参数、返回值、异常等。(1.42+)
格式:
Page 4 , Total 18
剩余18页未读,继续阅读
资源评论

- popebl2015-10-18还不错,值得学习

一耿
- 粉丝: 0
- 资源: 5
上传资源 快速赚钱
我的内容管理 展开
我的资源 快来上传第一个资源
我的收益
登录查看自己的收益我的积分 登录查看自己的积分
我的C币 登录后查看C币余额
我的收藏
我的下载
下载帮助


安全验证
文档复制为VIP权益,开通VIP直接复制
