java编码规范华为模板Word文件下载.docx
《java编码规范华为模板Word文件下载.docx》由会员分享，可在线阅读，更多相关《java编码规范华为模板Word文件下载.docx（30页珍藏版）》请在冰豆网上搜索。
凡是注
日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订
版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是
否可使用这些文件的最新版本。
凡是不注日期的引用文件，其最新
版本适用于本规范。
序号
编号
名称
1
公司-DKBA1040-.12
《Java语言编程规范》
3.术语和定义
规则：
编程时强制必须遵守的原则。
建议：
编程时必须加以考虑的原则。
格式：
对此规范格式的说明。
说明：
对此规范或建议进行必要的解释
示例：
对此规范或建议从正、反两个方面给出例子。
4.排版规范
4.1.规则
4.1.1.*程序块要采用缩进风格编写，缩进的空格数为4个。
对于由开发工具自动生成的代码能够有不一致。
4.1.2.*分界符（如大括号‘{'
和‘}'
）应各独占一行而且位于同一列，同
时与引用它们的语句左对齐。
在函数体的开始、类和接口的定
义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
如下例子不符合规范。
for（...）{
...IIprogramcode
}
if（...）
{
voidexample_fun（void）
应如下书写：
for（...）
voidexample_fun（void）{
4.1.3.
4.1.4.
*较长的语句、表示式或参数（>
80字符）要分成多行书写，长表示式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
if（filename!
=null
&
newFile（logPath+filename）.length（）<
LogConfig.getFileSize（））
...//programcode
publicstaticLogIteratorread（StringlogType,DatestartTime,DateendTime,
intlogLevel,StringuserName,intbufferNum）
不允许把多个短语句写在一行中，即一行只写一条语句示例：
LogFilenamenow=null;
LogFilenamethat=null;
LogFilenamethat=null;
4.1.5.
且if,for,do,
*if,for,do,while,case,switch,default等语句自占一行
while等语句的执行语句无论多少都要加括号{}。
if（writeToFile）writeFileThread.interrupt（）;
if（writeToFile）
{writeFileThread.interrupt（）;
4.1.6.*相对独立的程序块之间、变量说明之后必须加空行。
if（log.getLevel（）<
LogConfig.getRecordLevel（））
return;
LogWriterwriter;
return;
intindex;
4.1.7.*对齐只使用空格键，不使用TAB键
以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐。
JBuilder、UltraEdit等编辑环境，支持行首TAB替换成空格，应将该选项打开。
4.1.8.*在两个以上的关键字、变量、常量进行对等操作时，它们之间的
操作符之前、之后或者前后要加空格；
进行非对等操作时，如果是
关系密切的立即操作符（如.）,后不应加空格。
采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相正确，因此，在已经非常清晰的语
句中没有必要再留空格，如果语句已足够清晰则括号内侧（即左括号后
面和右括号前面）不需要加空格，多重括号间不必加空格，因为在Java语言中括号已经是最清晰的标志了。
在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。
给操作符留空格时不要连续留两个以上空格。
（1）逗号、分号只在后面加空格。
inta,b,c;
（2）比较操作符，赋值操作符"
="
、"
+="
算术操作符"
+"
%"
逻辑操作符"
，、"
"
位域操作符"
<
八"
等双目操作符的前后加空格。
if（current_time>
=MAX_TIME_VALUE）
a=b+c;
a*=2;
a=b八2;
⑶"
!
〜"
++"
--"
（地址运算符）等单目操作符前后
不加空格
flag=!
isEmpty;
//非操作"
与内容之间
i++;
//"
"
（4）"
."
前后不加空格。
p.id=pid;
前后不加空格
（5）if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。
if（a>
=b&
c>
d）
4.2.建议
类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。
类定义
类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
类的保护方法定义
类的私有方法定义
5.注释规范
5.1.规则
5.1.1.一般情况下，源程序有效注释量必须在30%以上。
注释的原则是有助于对程序的阅读理解，在该加的地方都加
了,注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
能够
用注释统计工具来统计。
5.1.2.包的注释：
包的注释写入一名为package.html的HTML格式说明文
件放入当前路径。
方便JavaDoc收集
com/huawei/msg/relay/comm/package.html
5.1.3.包的注释内容：
简述本包的作用、详细描述本包的内容、产品模块
名称和版本、公司版权。
说明:
在详细描述中应该说明这个包的作用以及在整个项目中的位
格式:
html>
body>
p>
一句话简述。
详细描述。
产品模块名称和版本
br>
公司版权信息v/body>
/html>
P>
为Relay提供通信类，上层业务使用本包的通信类与SP进行通
信。
。
vp>
MMSCV100R002Relay
（C）版权所有-文思创新技术有限公司
/body>
5.1.4
5.1.5
文件注释：
文件注释写入文件头部，包名之前的位置
注意以/*开始避免被JavaDoc收集
/*
*注释内容
*/
packagem;
文件注释内容：
版权说明、描述信息、生成日期、修改历史说明：
文件名可选。
*文件名：
［文件名］
*版权：
〈版权〉
*描述：
〈描述〉
*修改人：
〈修改人〉
*修改时间：
YYYY-MM-DD
*修改单号：
〈修改单号〉
*修改内容：
〈修改内容〉
每次修改后在文件头部写明修改信息，Checkin的时候能够直
接把蓝色字体信息粘贴到VSS的注释上。
在代码受控之前能够免去。
LogManager.java
*版权:
Copyright-HuaweiTech.Co.Ltd.AllRightsReserved.
MMSCV100R002Relay通用日志系统
张三
-02-16
新增
李四
-02-26
WSS368
王五
-03-25
WSS498
5.1.6.类和接口的注释：
该注释放在package关键字之后，class或者
interface关键字之前。
方便JavaDoc收集。
/**
publicclassCommManager
5.1.7.类和接口的注释内容：
类的注释主要是一句话功能简述、功能详细
描述。
可根据需要列出：
版本号、生成日期、作者、内容、功能、与其它类的关系等。
如果一个类存在Bug,请如实说明这些Bug。
*〈一句话功能简述〉
*〈功能详细描述〉
*@author［作者］
*@version［版本号，YYYY-MM-DD］
*@see［相关类/方法］
*@since［产品/模块版本］
*@deprecated
描述部分说明该类或者接口的功能、作用、使用方法和注
意事项，每次修改后增加作者和更新版本号和日期，@since表示从那个
版本开始就有这个类或者接口，@deprecated表示不建议使用该类或者接口。
*LogManager类集中控制对日志读写的操作。
*全部为静态变量和静态方法，对外提供统接口。
分配对应日志
类型的读写器，
*读取或写入符合条件的日志纪录。
*@author张三，李四，王五
*@version1.2,-03-25
*@seeLogIteraotor
*@seeBasicLog
*@sineeCommonLog1.0
5.1.8.
类属性、公有和保护方法注释：
写在类属性、公有和保护方法上面。
privateStringlogType;
publicvoidwrite（）
5.1.9.成员变量注释内容：
成员变量的意义、目的、功能,可能被用到的
地方。
5.1.10.公有和保护方法注释内容：
列出方法的一句话功能简述、功能详细
描述、输入参数、输出参数、返回值、违例等。
*@param［参数1］［参数1说明］
*@param［参数2］［参数2说明］
*@return［返回类型说明］
*@exception/throws［违例类型］［违例说明］
*@see［类、类#方法、类#成员］
@since表示从那个版本开始就有这个方法；
@exception或
throws列出可能仍出的异常；
@deprecated表示不建议使用该方法。
*根据日志类型和时间读取日志。
*分配对应日志类型的LogReader,指定类型、查询时间段、条件
和重复器缓冲数，
*读取日志记录。
查询条件为null或0表示无限制，重复器缓冲数
为0读不到日志。
*查询时间为左包含原则，即［startTime,endTime）。
*@paramlogTypeName日志类型名（在配置文件中定义的）
*@paramstartTime查询日志的开始时间
*@paramendTime查询日志的结束时间
*@paramlogLevel查询日志的级别
*@paramuserName查询该用户的日志
*@parambufferNum日志重复器缓冲记录数
*@return结果集，日志重复器
*@sineeCommonLogl.O
publicstaticLogiteratorread（StringlogType,DatestartTime,Date
endTime,
5.1.11.对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，
对于所调用的其它方法所抛出的异常，选择主要的在注释中说明。
对于非RuntimeExeeption,即throws子句声明会抛出的异常，必须在方法的注释中标明。
异常注释用@exception或@throws表示，在JavaDoe中两者等价，但推荐用@exception标注Runtime异常，@throws标注非Runtime异常。
异常的注释必须说明该异常的含义及什么条件下抛出该异常。
5.1.12.*注释应与其描述的代码相近，对代码的注释应放在其上方或右方
（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
5.1.13.*注释与所描述内容进行同样的缩排。
可使程序排版整齐，并方便注释的阅读与理解。
如下例子，排版不整齐，阅读稍感不方便。
publicvoidexample（）
//注释
CodeBlockOne
CodeBlockTwo
应改为如下布局。
publicvoidexample（）{
5.1.14.
*将注释与其上面的代码用空行隔开。
如下例子，显得代码过于紧凑
programcodeone
programcodetwo
5.1.15.*对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。
5.1.16.*对于switch语句下的case语句，如果因为特殊情况需要处理完一个
case后进入下一个case处理,必须在该case语句处理完、下一个case
语句前加上明确的注释。
这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。
5.1.17.*边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
不再有用的注释要删除。
5.1.18.*注释的内容要清楚、明了,含义准确,防止注释二义性。
说明：
错误的注释不但无益反而有害。
5.1.19.*避免在注释中使用缩写,特别是不常见缩写。
在使用缩写时或之前,应对缩写进行必要的说明。
5.2.建议
5.2.1.*避免在一行代码或表示式的中间插入注释。
除非必要,不应在代码或表示中间插入注释,否则容易使代码
可理解性变差。
5.2.2.*经过对函数或过程、变量、结构等正确的命名以及合理地组织代
码的结构，使代码成为自注释的。
清晰准确的函数、变量等的命名，可增加代码可读性，并减
少不必要的注释。
5.2.3.*在代码的功能、意图层次上进行注释，提供有用、额外的信息。
注释的目的是解释代码的目的、功能和采用的方法，提供代
码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。
示例:
如下注释意义不大。
//如果receiveFlag为真
if（receiveFlag）
而如下的注释则给出了额外有用的信息。
//如果从连结收到消息
5.2.4.*在程序块的结束行右方加注释标记，以表明某程序块的结束。
当代码段较长，特别是多重嵌套时，这样做能够使代码更清晰
更便于阅读
参见如下例子
programcodel
while（index<
MAX_INDEX）
programcode2
}//endofwhile（index<
MAX_INDEX）//
指明该条while语句结
束
}//endofif（...）//指明是哪条if语句结束
5.2.5.*注释应考虑程序易读及外观排版的因素，使用的语言若是中、英
兼有的，建议多使用中文，除非能用非常流利准确的英文表示。
注释语言不统一，影响程序易读性和外观排版，出于维护的考虑,建议使用中文。
5.2.6.方法内的单行注释使用〃。
调试程序的时候能够方便的使用/*。
*/注释掉一长段
程序。
5.2.7.注释尽量使用中文注释和中文标点。
方法和类描述的第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。
接下来的部分能够详细描述。
JavaDoc工具收集简介的时候使用选取第一句话。
5.2.8.顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代码前面进行注释。
如下是对设置属性的流程注释
〃1、判断输入参数是否有效。
OOOOO
//2、设置本地变量。
OOOOOO
5.2.9.一些复杂的代码需要说明。
这里主要是对闰年算法的说明
111.如果能被4整除，是闰年；
112.如果能被100整除，不是闰年.;
〃3.如果能被400整除，是闰年,
6.命名规范
6.1.规则
6.1.1.包名采用域后缀倒置的加上自定义的包名，采用小写字母。
在部门
内部应该规划好包名的范围，防止产生冲突。
部门内部产品使用部门的名称加上模块名称。
产品线的产品使用产品的名称加上模块的名称。
com.huawei.产品名.模块名称
com.huawei.部门名称.项目名称
Relay模块包名com.huawei.msg.relay
通用日志模块包名com.huawei.msg」og
6.1.2.类名和接口使用类意义完整的英文描述，每个英文单词的首字母使
用大写、其余字母使用小写的大小写混合法。
示例:
Orderlnformation,CustomerList,LogManager,LogConfig
6.1.3.方法名使用类意义完整的英文描述：
第一个单词的字母使用小写、
剩余单词首字母大写其余字母小写的大小写混合法。
privatevoidcalculateRate（）;
publicvoidaddNewOrder（）;
6.1.4.方法中，存取属性的方法采用setter和getter方法,动作方法采用动词和动宾结构。
get+非布尔属性名（）
is+布尔属性名（）
set+属性名（）
动词（）
动词+宾语（）
publicStringgetType（）;
publicbooleanisFinished（）;
publicvoidsetVisible（boolean）;
publicvoidshow（）;
publicvoidaddKeyListener（Listener）;
6.1.5.属性名使用意义完整的英文描述：
第一个单词的字母使用小写、余单词首字母大写其余字母小写的大小写混合法。
属性名不能与方法名相同。
privatecustomerName;
privateorderNumber;
privatesmpSession;
6.1.6.
而且
常量名使用全大写的英文描述，英文单词之间用下划线分隔开使用finalstatic修饰。
publicfinalstaticintMAX_VALUE=1000;
publicfinalstaticStringDEFAULT_START_DATE="
-12-08"
;
6.1.7.属性名能够和公有方法参数相同，不能和局部变量相同，引用非静态成员变量时使用this引用，引用静态成员变量时使用类名引用。
publicclassPerson
privateStringname;
privatestaticListproperties;
publicvoidsetName（Stringname）
this.name=name;
publicvoidsetProperties（Listproperties）
Person.properties=properties;
常见组件类的命名以组件名加上组件类型名结尾
Application类型的，命名以App结尾
MainApp
Frame类型的，命名以Frame结尾
TopoFrame
Panel类型的，建议命名以Panel结尾
CreateCircuitPanel
Bean类型的，建议命名
升级会员 