第1页 / 共18页
第2页 / 共18页
第3页 / 共18页
第4页 / 共18页
第5页 / 共18页
第6页 / 共18页
第7页 / 共18页
第8页 / 共18页
华为Java代码规范.doc
1 Java 编程规范
1.1 排版
1.1.1 规则
1.1.2 建议
1.2 注释
1.2.1 规则
1.2.2 建议
1.3 命名
1.3.1 规则
1.3.2 建议
1.4 编码
1.4.1 规则
1.4.2 建议
1.5 性能与可靠性
1.5.1 规则
1.5.2 建议
2 附录
2.1 Eclipse 华为风格
2.2 Eclipse 注释模板
2.3 JBuilder 华为风格(Jbuilder2007以下版本,不包括2007版)
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();
密级:内部公开
int i = 9;
case x:
{
}
规则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
一句话简述。
详细描述。
产品模块名称和版本
公司版权信息
示例：
为 WEBSMAP 提供通信类，上层业务使用本包的通信类与 SMP-B 进行通信。
详细描述。。。。。。。。
IIN V100R001 WEBSMAP
(C) 版权所有 2000-2001 华为技术有限公司
规则3 类和接口的注释放在class 或者 interface 关键字之前，import 关键字之后。注
释主要是一句话功能简述与功能详细描述。类注释使用“/**
*/”注释方式(1.42+)
说明：方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出：作者、内容、功
能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事
Page 3 , Total 18
密级:内部公开
项，每次修改后增加作者和更新版本号和日期，@since 表示从那个版本开始就有这个类或
者接口，@deprecated 表示不建议使用该类或者接口。
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @author
* @see
* @since
* @deprecated （可选）
*/
[作者]（必须）
[相关类/方法]（可选）
[产品/模块版本] （必须）
示例：
package com.huawei.iin.logwebsmap.comm;
import java.util.*;
/**
* LogManager 类集中控制对日志读写的操作。
* 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器，
* 读取或写入符合条件的日志纪录。
* @author
张三，李四，王五
LogIteraotor
* @see
* @see
BasicLog
* @since
CommonLog1.0
*/
public class LogManager
规则4 类属性(成员变量)、公有和保护方法注释：写在类属性、公有和保护方法上面，注释方
式为“/**
*/”.(1.42+)
示例：
/**
* 注释内容
*/
private String logType;
/**
* 注释内容
*/
public void write()
规则5 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、
输出参数、返回值、异常等。(1.42+)
格式：
/**
* 〈一句话功能简述〉
Page 4 , Total 18
密级:内部公开
[返回类型说明]
[参数1说明]
[参数2说明]
* 〈功能详细描述〉
* @param [参数1]
* @param [参数2]
* @return
* @exception/throws [异常类型] [异常说明]
* @see
* @since [起始版本]
* @deprecated
*/
[类、类#方法、类#成员]
说明：@since 表示从那个版本开始就有这个方法，如果是最初版本就存在的方法无需说明；
@exception或throws 列出可能仍出的异常；@deprecated 表示不建议使用该方法。
示例：
/**
* 根据日志类型和时间读取日志。
* 分配对应日志类型的LogReader， 指定类型、查询时间段、条件和反复器缓冲数，
* 读取日志记录。查询条件为null或0的表示没有限制，反复器缓冲数为0读不到日志。
* 查询时间为左包含原则，即 [startTime, endTime) 。
* @param logTypeName 日志类型名（在配置文件中定义的）
* @param startTime
* @param endTime
* @param logLevel
* @param userName
* @param bufferNum
* @return 结果集，日志反复器
* @since 1.2
*/
public static LogIterator read(String logType, Date startTime,
Date endTime, int logLevel, String userName, int bufferNum)
查询日志的级别
查询该用户的日志
日志反复器缓冲记录数
查询日志的开始时间
查询日志的结束时间
规则6 对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他
方法所抛出的异常，选择主要的在注释中说明。 对于非RuntimeException，即throws
子句声明会抛出的异常，必须在方法的注释中标明。(1.42+)
说明：异常注释用@exception或@throws表示，在JavaDoc中两者等价，但推荐用@exception标注
Runtime异常，@throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛
出该异常。
规则7 注释应与其描述的代码相近，对代码的注释应放在其上方，并与其上面的代码用空行隔
开，注释与所描述内容进行同样的缩排。(1.42+)
说明：可使程序排版整齐，并方便注释的阅读与理解。
示例：
/*
* 注释
*/
public void example2( )
{
Page 5 , Total 18
密级:内部公开
// 注释
CodeBlock One
// 注释
CodeBlock Two
}
/*
* 注释
*/
public void example( )
{
// 注释
CodeBlock One
// 注释
CodeBlock Two
}
规则8 对于switch语句下的case语句，必须在每个case分支结束前加上break语句。(1.42+)
说明：break才能真正表示该switch执行结束，不然可能会进入该case以后的分支。至于语法上合
法的场景“一个case后进入下一个case处理”，应该在编码设计上就避免。
规则9 修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
(1.42+)
规则10 注释的内容要清楚、明了，含义准确，防止注释二义性。(1.42+)
说明：错误的注释不但无益反而有害。
规则11 避免在注释中使用缩写，特别是不常用缩写。(1.42+)
说明：在使用缩写时或之前，应对缩写进行必要的说明。
规则12 对重载父类的方法必须进行@Override声明(5.0+)
说明：可清楚说明此方法是重载父类的方法，保证重载父类的方法时不会因为单词写错而造成错
误(写错方法名或者参数个数，类型都会编译无法通过)
示例：
@Override
public void doRequest(SipServletRequest req) throws ServletException,
IOException
1.2.2 建议
建议1 避免在一行代码或表达式的中间插入注释。(1.42+)
说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。
Page 6 , Total 18
密级:内部公开
建议2 在代码的功能、意图层次上进行注释，提供有用、额外的信息。(1.42+)
说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解
代码，防止没必要的重复注释信息。
示例：如下注释意义不大。
// 如果 receiveFlag 为真
if (receiveFlag)
而如下的注释则给出了额外有用的信息。
// 如果从连结收到消息
if (receiveFlag)
建议3 对关键变量的定义和分支语句（条件分支、循环语句等）必须编写注释。(1.42+)
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好
的理解程序，有时甚至优于看设计文档。
建议4 注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中
文，除非能用非常流利准确的英文表达。中文注释中需使用中文标点。方法和类描述的
第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。接下来的部分可以详细
描述。(1.42+)
说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。
JavaDoc工具收集简介的时候使用选取第一句话。
建议5 方法内的单行注释使用 //。(1.42+)
说明：调试程序的时候可以方便的使用 /* 。。。*/ 注释掉一长段程序。
建议6 一些复杂的代码需要说明。(1.42+)
示例：这里主要是对闰年算法的说明。
//1. 如果能被4整除，是闰年；
//2. 如果能被100整除，不是闰年；
//3. 如果能被400整除，是闰年。
建议7 使用Html标签使JavaDoc生成更加美观。(1.42+)
示例：
/**
* Returns a hash code for this string. The hash code for a
*
String object is computed as
* * using* s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1] *
int arithmetic, where s[i] is the
* ith character of the string, n is the length
* of
* the string, and ^ indicates exponentiation.
* (The hash value of the empty string is zero.)
Page 7 , Total 18
密级:内部公开
*
* @return a hash code value for this object.
*/
public int hashCode()
生成后的JavaDoc
图1 生成后的JavaDoc
1.3 命名
1.3.1 规则
规则1 类名和接口使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使
用小写的大小写混合法。(1.42+)
示例：OrderInformation, CustomerList, LogManager, LogConfig, SmpTransaction
规则2 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写
其余字母小写的大小写混合法。(1.42+)
示例：
private void calculateRate();
public void addNewOrder();
规则3 方法中，存取属性的方法采用setter 和 getter方法，动作方法采用动词和动宾结构。
(1.42+)
格式：
get + 非布尔属性名()
is + 布尔属性名()
set + 属性名()
动词()
动词 + 宾语()
示例：
public String getType();
public boolean isFinished();
public void setVisible(boolean);
public void show();
public void addKeyListener(Listener);
Page 8 , Total 18
相关推荐
2023年江西萍乡中考道德与法治真题及答案.doc
2012年重庆南川中考生物真题及答案.doc
2013年江西师范大学地理学综合及文艺理论基础考研真题.doc
2020年四川甘孜小升初语文真题及答案I卷.doc
2020年注册岩土工程师专业基础考试真题及答案.doc
2023-2024学年福建省厦门市九年级上学期数学月考试题及答案.doc
2021-2022学年辽宁省沈阳市大东区九年级上学期语文期末试题及答案.doc
2022-2023学年北京东城区初三第一学期物理期末试卷及答案.doc
2018上半年江西教师资格初中地理学科知识与教学能力真题及答案.doc
2012年河北国家公务员申论考试真题及答案-省级.doc
2020-2021学年江苏省扬州市江都区邵樊片九年级上学期数学第一次质量检测试题及答案.doc
2022下半年黑龙江教师资格证中学综合素质真题及答案.doc
