华为JAVA编码规范Word文件下载.doc
《华为JAVA编码规范Word文件下载.doc》由会员分享，可在线阅读，更多相关《华为JAVA编码规范Word文件下载.doc（14页珍藏版）》请在冰豆网上搜索。
{
…//yourcode
4.一行只写一条语句
LogFilenamewow=null;
LogFilenamethat=null;
5.if,for,do,switch,while,case,default各占一行,它们的执行语句无论多少都要加{}
if（writeToFile）
writeFileThread.interrupt（）;
6.相对独立的程序块,变量,说明要加空行
if（log.getLevel（）<
log.getRecord（））
return;
//空行
LogWritewriter;
7.对齐只用空格键,不用TAB键
以免使用不同的编辑器阅读程序时,因TAB键所设置的空格数不同而造成程序布局不整齐,JBuildr,UltraEdit等编辑环境,支持行首TAB替换成空格,应将该选项打开
8.两个以上的关键字,变量,常量进行对等操作时,操作符之前,之后或前后要加空格,进行非对等操作时,如果是关系密切的立即操作符,后面不加空格（如.操作符）
采用这种松散方式编写代码目的是让程序更加清晰,由于空格所产生的清晰性是相对的,所以在已经很清晰的语句中没有必要留空格,如果语句已足够清晰,则括号内侧（即左括号后面和右括号前面）不需要加空格,多重括号间不必加空格,因为java中括号已经是很清晰的标志了.在长句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部中不加空格,给操作符留空格时不要连续留两个以上空格
9.类属性和方法不要交叉放置,不同存取范围的属性和方法也不要交叉放置
类定义:
类公有属性定义;
类保护属性定义;
类私有属性定义;
类公有方法定义;
类保护方法定义;
类私有方法定义;
10.源程序的有效注释量必须在30%以上
11.包的注释写入一个名为package.html的html格式的说明文件放入当前路径
12.包的注释内容:
本包作用,详细描述本包内容,产品模块名称及版本,公司版本
<
html>
body>
p>
一句话描述
详细描述
产品模块
br>
公司版本信息
/body>
/html>
13.文件注释:
写入文件头部,包名之前
14.文件注释内容:
版本说明,描述信息,修改历史,生成日期
/*
*文件名
*版权
*描述
*修改人
*修改时间
*修改内容
*跟踪单号
*修改单号
*/
15.类和接口注释:
放在package注释之后,class或interface之前
16.类和接口注释内容:
类的注释要一句话功能描述,功能详细描述
/**
*<
一句话功能简述>
功能详细描述>
*@author
*@version
*@see[相关类/方法]
*@since[产品/模块版本]
*@deprecated（表示不建议使用该类或者接口）
17.类属性,公有和保护方法注释:
写在类属性,公有和保护方法上面
18.成员变量注释内容:
成员变量的意义,目的,功能,可能被用到的地方
19.公有和保护方法注释的内容:
方法的一句话功能描述,功能详细描述,输入参数,输出参数,返回值,违例
*@param
*@return
*@exception/throws
*/
20.对于方法内部用throw抛出的异常,要在方法的注释中标明,对于调用其他方法抛出的异常,选主要的在注释中说明,对于非RuntimeException,即throws子句声明会抛出的异常,必须在方法的注释中标明
21.注释应与描述的代码相近,对代码的注释应放在代码上方或者右方（单行注释）相邻位置,不可放在下面,如放于上方则与上面代码用空行隔开
22.注释与描述的内容进行同样的缩进
23.对变量的定义和分支语句,必须加以注释
24.对于switch下的case语句,如果处理完一个case要进入下一个case,必须在该case处理完,下一个case前加上明确的注释
这样比较清楚程序编写者的意图，有效防止无故遗漏break语句
25.边写代码边写注释,修改代码同时修改注释保证代码和注释一致,没用的注释要删除
26.注释内容要清楚,明了,含义明确,防止二义性
27.不要在注释中用缩写
说明：
除非必要,在使用缩写时或之前，应对缩写进行必要的说明
28.不要在一行代码或表达式中间加注释
除非必要，不应在代码或表达式中间插入注释，否则容易使代码可理解性变差。
29.通过对函数,过程,变量,结构的正确命名,以及合理的组织代码,使代码成为自注释的
30.在代码的功能,意图层次上进行注释,提供有用的,额外的信息
示例.如下注释意义不大。
//如果receiveFlag为真。
If（receiveFlag）
而如下的注释则给出了额外有用的信息。
//如果从连结收到信息
If（receiveFlag）
31.在代码结束行的右方加注释,以表明程序块的结束
当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。
示例：
参见如下例子。
If（……）
{
programcode1
while（index
<
MAX_INDEX）
programcode2
}//endofwhile（index
MAX_INDEX）//指明该条while语句结束。
}//endofIf（……）//指明是哪条if语句结束。
32.注释考虑程序的易读和外观的排版,使用的语句若是中,英文都有,建议多使用中文,除非能用非常流利,准确的英文
33.方法内的单行注释用//
调试程序的时候可以方便的使用/*……*/注释掉一长段程序。
34.注释用中文注释和中文标点,方法和类的描述第一句话使用简洁明了的话概括功能,然后加句号.接下来的部分可以详细描述
JavaDoc工具收集简介的时候使用选取第一句话。
35.顺序实现流程的说明使用1,2,3,4.在每个实现步骤的代码前进行注释
如下是对设置属性的流程注释。
//1.判断输入参数是否有效。
……
//2.设置本地变量
36.一些复杂的代码要说明
这里主要是对闰年算法的说明。
//1.如果能被4整除，是闰年；
//2.如果能被100整除，不是闰年；
//3.如果能被400整除，是闰年；
37.包名采用域后缀倒置加上自定义包名,用小写字母,在部门内部要规划好包名的范围,防止冲突,部门内部产品使用部门的名称加上模块名称,产品线的产品使用产品的名称加上模块名称
格式：
com.huawei.产品名.模块名称
com.huawei.部门名称.项目名称
融合WEBSMAP包名com.huawei.iin.websmap
通用消息转发包名com.huawei.insa2.msgtrans
38.类名和接口使用完整意义的英文描述,英文首字母大写,其他使用小写和大写的混合
OrderInformation，CustomerList，LogManager，LogConfig，SmpTransation
39.方法名使用完整意义的英文描述,首字母小写,剩余字母首字母大写,其他字母小写
privatevoidcalculateRate（）；
publicvoidaddNewOrder（）；
40.方法中存取属性的方法用setter方法和getter方法,动作方法采用动词和动宾结构
get+非布尔属性名（）
set+属性名（）
is+布尔属性名（）
动词（）
动词+宾语（）
publicStringgetType（）；
publicbooleanisFinished（）；
publicvoidsetVisible（boolean）；
publicvoidaddKeyListener（Listener）；
41.属性名使用完整意义的英文描述,第一个单词字母小写,剩余单词首字母大写,其余字母小写,属性名不能和方法名相同
privatecustomerName；
privateorderNumber；
privatesmpSession；
42.常量名使用全大写英文,英文单词之间用下划线隔开,并使用finalstatic修饰
publicfinalstaticintMAX_VALUE=1000；
publicfinalstaticStringDEFAULT_START_DATE=“2008-11-06”；
43.属性名可以和公有方法参数相同,不能和局部变量相同,引用非静态成员变量时用this,引用静态成员变量时用类名
publicclassPerson
privateStringname；
privatestaticListproperties;
publicvoidsetName（Stringname）
this.name=name；
publicvoidsetProperties（Listproperties）
Person.Properties=properties；
44.常用组件的命名以组件名加上组件类型名结尾
Applicatio
升级会员 