华为JAVA编码规范.pdf

《华为JAVA编码规范.pdf》由会员分享，可在线阅读，更多相关《华为JAVA编码规范.pdf（23页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、密级:内部公开1.程序块采用缩进风格,空格为 4 个.说明:对于开发工具自动生成的代码可以不一致2.分界符(如大括号和)应各自占一行并且在同一列,同时与引用它们的语 句 左 对 齐,在 方 法 的 开 始,类 和 接 口 的 定 义,以 及if,for,do,while,switch,case 语句都要采用上述缩进说明:for()说明:if(filename!=null&new File(logPath+filename).length()()3.作符)说明:采用这种松散方式编写代码目的是让程序更加清晰,由于空格所产生的清晰性是相对的,所以在已经很清晰的语句中没有必要留空格,如果语句已足够清晰

2、,则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为 java 中括号已经是很清晰的标志了.在长句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部密级:内部公开中不加空格,给操作符留空格时不要连续留两个以上空格4.类属性和方法不要交叉放置,不同存取范围的属性和方法也不要交叉放置说明:类定义:类公有属性定义;类保护属性定义;类私有属性定义;类公有方法定义;类保护方法定义;类私有方法定义;5.源程序的有效注释量必须在 30%以上6.包的注释写入一个名为的 html 格式的说明文件放入当前路径7.包的注释内容:本包作用,详细描述本包内容,产品模块名称及版本,公司

3、版本说明:一句话描述 详细描述密级:内部公开 产品模块 公司版本信息 8.文件注释:写入文件头部,包名之前9.文件注释内容:版本说明,描述信息,修改历史,生成日期说明:/*文件名 *版权 *描述 *修改人 *修改时间 *修改内容 *跟踪单号 *修改单号 */10.类和接口注释:放在 package 注释之后,class 或 interface 之前11.类和接口注释内容:类的注释要一句话功能描述,功能详细描述说明:密级:内部公开/*author*version*see 相关类/方法*since 产品/模块版本*deprecated(表示不建议使用该类或者接口)12.类属性,公有和保护方法注释:

4、写在类属性,公有和保护方法上面13.成员变量注释内容:成员变量的意义,目的,功能,可能被用到的地方14.公有和保护方法注释的内容:方法的一句话功能描述,功能详细描述,输入参数,输出参数,返回值,违例说明:/*param*return*exception/throws*/15.对于方法内部用 throw 抛出的异常,要在方法的注释中标明,对于调用其 他 方 法 抛 出 的 异 常,选 主 要 的 在 注 释 中 说 明,对 于 非RuntimeException,即 throws 子句声明会抛出的异常,必须在方法的注密级:内部公开释中标明16.注释应与描述的代码相近,对代码的注释应放在代码上方或

5、者右方(单行注释)相邻位置,不可放在下面,如放于上方则与上面代码用空行隔开17.注释与描述的内容进行同样的缩进18.对变量的定义和分支语句,必须加以注释19.对于 switch 下的 case 语句,如果处理完一个 case 要进入下一个 case,必须在该 case 处理完,下一个 case 前加上明确的注释说明:这样比较清楚程序编写者的意图，有效防止无故遗漏 break 语句20.边写代码边写注释,修改代码同时修改注释保证代码和注释一致,没用的注释要删除21.注释内容要清楚,明了,含义明确,防止二义性22.不要在注释中用缩写说明：除非必要,在使用缩写时或之前，应对缩写进行必要的说明23.不

6、要在一行代码或表达式中间加注释说明：除非必要，不应在代码或表达式中间插入注释，否则容易使代码可理解性变差。24.通过对函数,过程,变量,结构的正确命名,以及合理的组织代码,使代码密级:内部公开成为自注释的25.在代码的功能,意图层次上进行注释,提供有用的,额外的信息示例.如下注释意义不大。26.下来的部分可以详细描述说明：JavaDoc 工具收集简介的时候使用选取第一句话。27.顺序实现流程的说明使用 1,2,3,4.在每个实现步骤的代码前进行注释示例：如下是对设置属性的流程注释。断输入参数是否有效。置本地变量28.一些复杂的代码要说明示例：这里主要是对闰年算法的说明。果能被 4 整除，是闰年

7、；果能被 100 整除，不是闰年；果能被 400 整除，是闰年；29.包名采用域后缀倒置加上自定义包名,用小写字母,在部门内部要规划好包名的范围,防止冲突,部门内部产品使用部门的名称加上模块名称,产品线的产品使用产品的名称加上模块名称格式：.产品名.模块名称密级:内部公开 .部门名称.项目名称30.示例：融合 WEBSMAP 包名通用消息转发包名类名和接口使用完整意义的英文描述,英文首字母大写,其他使用小写和大写的混合示例：OrderInformation，CustomerList，LogManager，LogConfig，SmpTransation31.方法名使用完整意义的英文描述,首字母小

8、写,剩余字母首字母大写,其他字母小写示例：private void calculateRate（）；public void addNewOrder（）；32.方法中存取属性的方法用 setter 方法和 getter 方法,动作方法采用动词和动宾结构格式：get+非布尔属性名（）set+属性名（）is+布尔属性名（）动词（）动词+宾语（）示例：public String getType（）；public boolean isFinished（）；public void setVisible（boolean）；public void addKeyListener（Listener）；密级:内部公

9、开33.属性名使用完整意义的英文描述,第一个单词字母小写,剩余单词首字母大写,其余字母小写,属性名不能和方法名相同示例：private customerName；private orderNumber；private smpSession；34.常量名使用全大写英文,英文单词之间用下划线隔开,并使用 finalstatic 修饰示例：public final static int MAX_VALUE=1000；publicfinalstaticStringDEFAULT_START_DATE=“2008-11-06”；35.属性名可以和公有方法参数相同,不能和局部变量相同,引用非静态成员变量时

10、用 this,引用静态成员变量时用类名示例：public class Personprivate String name；private static List properties;public void setName(String name)=name；密级:内部公开public void setProperties(List properties)Person.Properties=properties；36.常用组件的命名以组件名加上组件类型名结尾示例：Application 类型的，命名以 App 结尾-MainApp；Frame 类型的，建议命名以 Frame 结尾-TopoFr

11、ame；Panel 类型的，建议命名以 Panel 结尾CreateCircuitPanel；Bean 类型的，建议命名以 Bean 结尾-DataAccessBean；EJB 类型的，建议命名以 EJB 结尾-DBProxyEJB；Applet类 型 的，建 议 命 名 以Applet结 尾-PictureShowApplet；37.函数名超过 15 个字母可采用去掉元音字母的方法或行业内约定俗成的缩写方式缩写函数名示例：getCustomerInformation（）改为 getCustomerInfo（）38.准确的确定成员函数的存取控制符,不是必须使用public 的请用protect

12、ed,不是必须用 protected 的请用 private示例：protected void setUserName（）private void calculateRate（）密级:内部公开39.含有集合意义的属性命名,尽量包含复数的意义示例：customes；orderItems40.明确方法功能,精确实现方法设计,一个函数完成一个功能,简单的功能也要编写方法实现说明：虽然为仅用一两行就可以完成的功能去编写方法好像没有必要，但用方法可使功能明确化，增加程序可读性，亦可方便维护、测试。41.明确规定对接口方法参数的合法性检查应由方法的调用者负责还是有接口方法本身负责,缺省由方法调用者负责说明

13、：对于模块间接口方法参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患，要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。42.明确类的功能,精确实现类的设计,一个类仅实现一组相近功能说明：划分类的时候，应该尽量把逻辑处理、数据和显示分离。实现类功能的单一性。示例：数据类不能包含数组处理的逻辑通信类不能包含显示处理的逻辑43.所有的数据类必须重载 toString()方法,返回该类有意义的内容说明：父类如果实现了比较合理的 toString（）

14、，子类可以继承不密级:内部公开必再重写。示例：public TopoNode private String nodeName；public String toString（）Return“NodeName：”+nodeName；44.数据库操作,IO 操作要使用 close()的对象要在 try-catch-finally 的finally 中 close()示例：try45.往看不出出了什么错.46.一个方法不应抛出太多类型的异常47.异常捕获尽量不要直接 catch(Exception ex),要把异常细分处理48.如果多段代码重复做同一件事情,那么在方法划分上可能存在问题49.对于创建的

15、主要的类,最好置入 main()方法,包含用于测试那个类的代码50.集合中的数据如果不使用应及时释放,尤其是可重复使用的集合51.源程序中关系紧密的代码应尽可能相邻密级:内部公开52.不要使用难懂的技巧很高的语句,除非很有必要53.在 switch 中每个 case 后面要加上 return 或者 break54.在运算中不要减少数据精度55.switch 中的 case 要和后面的常量保持一个空格,switch 语句中不要定义 case 之外的无用标签56.不要在 if 中使用等号=进行赋值57.静态成员或方法使用类名访问,不使用句柄访问58.方法重载时,方法名一定要相同,避免类中使用两个相

16、似的方法名76.包的注释内容要求:简述本包的作用 详细描述本包的内容,产品模块名称和版本,公司版权77.不要在 Componentlisttener,componentResied()方法中调用serResize()方法.78.不要覆盖父类的静态方法和私有方法79.不要覆盖父类的属性80.不要使用二级以上的内部类81.把内部类定义成私有类82.去掉接口中多余的定义(不使用 public,abstaract,static,final等这是接口默认的)83.不要定义不会被用到得局部变量,类私有属性和私有方法和方法参数84.显示初始化所有的静态属性85.不要使用 System,getenv()方法8

17、6.不要硬编码 n r 作为换行符密级:内部公开87.不要直接使用里面的接口88.使用(),不使用循环来复制数组89.避免不必要的 instanceof 比较运算和类造型运算90.不要在 finalize()方法中删除监听器(listeners)91.在 finalize()方法中的 finally 中调用()方法92.在 finalize()方法中调一定调用()方法93.进行字符转换的时候应该尽可能的较少临时变量94.使用 ObjectStream 的方法后,调用 reset()释放对象95.线程同步中,在循环里面使用条件测试(使用 while(isWait)wait()代替 If(iswa

18、it)wait)96.不调用 Thread 类的 resume(),suspend(),stop()方法97.减小单个方法的复杂度使用的 if,while,for,switch 语句要在 10 个以内98.在 servelts 中重用 jdbc 连接数据源99.减少在 servle 中使用的同步方法100.101.102.不定义在包中没有被用到的友好的属性,方法和类没有子类的友好类应该定义为 final 方法定义为 final数据库操作,IO 操作等需要使用结束 close()的对象必须try-catch-catch-finally 的 finally 中 close().103.104.10

19、5.为 switch 语句提供一个 default 选项不要在 for 循环体中对计数器赋值不要给非公有类定义 public 构造器密级:内部公开106.107.不要对浮点数进行比较运算 如=!=减少运算实现 equals()方法时先用 getClass()或者 instanceof 进行类型比较通过后才能继续比较108.109.110.111.不要重载 main()方法用作除入口以外的其它用途方法的参数后不要和类中的方法名相同除了构建器外,不要使用和类名相同的方法名不要定义 Error 和 RuntimeException 的子类,可以定义 Exception的子类112.113.114.线

20、程中需要实现 run()方法使用 equals()比较两个类的值是否相同字符串和数字运算结果连接的时候,应该是把数字运算部分用小括号括起来115.116.类中不要使用非私有(公有,保护,友好)的非静态属性在类中对于没有实现的接口应该定义成抽象方法,类应该定义成抽象类117.118.119.120.121.122.123.不要显示导入.*包初始化时不要使用类的非静态属性显示初始化时所有的局部变量,按照方法名把方法排序放置,同名和同类型的方法应该放在一起不要在抽象类的构造器中调用抽象方法重载 equals()方法时应该重载 hashcode()方法工具类不要定义构造器包括私有构造器密级:内部公开1

21、24.125.126.127.128.129.130.不要在 switch 中使用 10 个以上的 case 语句把 main()方法放在类的最后生命方法违例的时候不要使用 Exception 应该使用它的子类不要直接扔出一个 error 应该扔出它的子类在进行比较的时候,总是把常量放在同一边在可能的情况下,总是为类定义一个缺省的构造器在捕捉异常的时候不使用Exception,RuntimException,Throwable 最好用它子类131.132.133.134.135.136.137.138.139.140.141.142.143.在接口和工具类中定义常量,使用大写”L”表示 lon

22、g 常量方法需要同样数量参数的注释用param不要在注释中使用不支持的标示unsupported不要使用 Runtime,exec()方法不要使用自定义本地方法使用集合时初始化容量不要在循环体内调用同步方法和使用复杂的表达式不要在循环体内定义变量,使用 StringBuffer 时初始化容量少用!尽可能对接口进行 instanceof 运算不要显示调用 finalize()密级:内部公开144.145.146.147.148.149.150.151.152.153.154.155.156.157.158.在不要使用静态集合 其内存占用增长没有界限不要重复调用一个方法获取对象,使用局部变量重用对

23、象线程中用 notifyAll()代替 notify();避免在同步方法中调用另一个同步方法造成的死锁,非同步方法中不能调用 wait()notify()方法不要使用同步方法,使用同步块用 wait()notify()代替 while()sleep(),把所有的公有方法定义为同步方法实现 Runable,run()方法必须是同步方法在 clone()方法中应该而且必须使用()而不是 new使用 StringTokenizer 代替 indexof()和 substrin()不要对参数进行赋值不要使用 String 类的 compareTo()equals()方法不要使用 servler 的 S

24、ingletThreadModel 会消耗大量资源Switch 中每个 Case 语句都应该包含 break 或者 return。for，if,，while 语句。159.不要使用空的160.在运算中不要减小数据的精度。161.Switch 语句中的 Case 关键字要和后面的常量保持一个空格，Switch语句中不要定义 Case 之外的无用标签。162.不要在 if 语句中使用等号=进行赋值操作。163.静态成员或者方法使用类名访问，不使用句柄访问。164.方法重载的时候，一定要注意方法名相同，避免类中使用两个非常相密级:内部公开似的方法名。165.不 要 在ComponentListene

25、r,ComponentResized()方 法 中 调 用serResize()方法。166.不要覆盖父类的静态方法和私有方法。167.不要覆盖父类的属性。168.不要使用两级以上的内部类。169.把内部类定义成私有类。170.去掉接口中多余的定义（不使用 public,abstrac,static,final 等，这是接口中默认的）。171.不要定义不会被用到的局部变量，类私有属性，类私有方法和方法参数。172.显式寝化所有的静态属性。173.不要使用 System getenr()方法。174.不要硬编码n和r作为换行符号。175.不要直接使用里面的接口。176.使用 System.arr

26、aycopy()，不要使用循环来复制数组。instenceof 比较运算和类造型运算。177.避免不必要的178.不要在179.在180.在finalize()方法中删除临听器(listeners)。finalize()方法中一定要调用 super finalize()方法。finalize()方法中的 finally 中调用 super finalize()方法。181.进行字符转换的时候应该尽可能的较少用临时变量。182.使用 Object stream 的方法后，调用 reset()释放对象。密级:内部公开183.线程同步中，在循环里面使用条件测试（使用 while(isWait)Wai

27、t()代替 if(isWait)Wait()）。184.不使用 Thread 类的 resume(),suspend(),stop()方法。if,while,for,switch 语句要在 10185.减小单个方法的复杂性度，使用的个以内。186.在 Servlet 中，重用 JDBC 连接的数据源。Servlets 中使用的同步方法。187.减少在188.不定义在包中没有被用到的友好属性，方法和类。189.没有子类的友好类应该定义成 final。final。190.没有被覆盖的友好方法应该定义成191.为 Switch 语句提供一个 default 选项。for 循环体中对计数器的赋值。pu

28、blic 构建器。192.不要在193.不要给非公有类定义194.不要对浮点数进行比较运算，尤其是不要进行=,!=运算，减少,。234.一个字符的连接使用而不使用“”，如：String a=b+c。235.不要在循环体内调用同步方法和使用 try-catch 块。if(a236.不要使用不必要的布尔值比较，如：if(a equals(b)，而不是equals(b)=true)。237.常量字符串使用 String,非常量字符串使用 StringBuffer。密级:内部公开238.在循环条件判断的时候不要使用复杂的表达式。239.对 于”if(condition)do1;elsedo2;”语 句

29、 使 用 条 件 操 作 符“if(condition)do1:do2”。240.不要在循环体内定义变量。241.使用 StringBuffer 的时候设置初始容量。242.尽可能的使用局部变量进行运算。243.尽可能少的使用“！”操作符。244.尽可能的对接口进行245.不要使用instanceof 运算。Date，而要使用 long替代。finalize()。246.不要显式调用247.不要使用静态集合，其内存占用增长没有边界。248.不要重复调用一个方法获取对象，使用局部变量重用对象。249.线程同步中，使用 notifyAll()代替 notify()250.避免在同步方法中不能调用另

30、一个同步方法造成死锁。251.非同步方法中不能调用252.使用wait(),notify()方法。wait(),notify()代替 while(),sheep().级）。级）。253.不要使用同步方法，使用同步块（5254.把所有的公有方法定义为同步方法（5255.实现的 Runnable run()方法必须是同步方法（5 级）。abstract 方法 final static 属性的类应该定义成接口。256.一个只有257.在 clone()方法中应该而且必须使用 super clone()而不是 new.final.258.常量必须定义为密级:内部公开259.在260.在for 循环中提

31、供终止条件。for,while 循环中使用增量计数。String Tokenizer 代替 indexof()和 substring.final 方法。261.使用262.不要在构造器中使用非263.不要对参数进行赋值操作。264.不要通过名字比较两对象的类，应该使用265.安全：尽量不要使用内部类。266.安全：尽量不要使用类可以克隆。267.安全：尽量不要使用接口可以序列化。268.安全：尽量不要使用友好方法，属性和类。269.servlet：不要使用270.servlet：不要使用getclass().Javabeans Beans instantiate()方法。Http Sessio

32、n 时，应该尽早使用 inralidate 方法释放.271.servlet：不要使用272.servlet：不要使用JDBC 资源时，应该使用 close()方法释放.servlet 的 Single Thread Monde,会消耗大量资源。Messag Format273.国际化：不要使用一个字符进行逻辑操作，使用274.国际化：不要使用 Date to String(),Time to String()方法。275.国际化：字符和字符串常量应该放在资源文件中276.国际化：字符使用数字277.国际化：不要使用278.国际化：不要使用toString()方法。StringBuffer String Tokenizer 类。String 类的 compareTo(),equals()方法。279.复杂度：建议最大规模：密级:内部公开280.继承层次 5 层行（包含）281.类的行数 1000282.类的属性 10 个个个283.类的方法 20284.类的友方法 10285.类私有方法 15286.类保护方法 10287.类公有方法 10288.类调用方法 20289.方法参数 5290.Return 语句291.方法行数 30292.方法代码 20293.注释比率 30%50%个个个个个个行 1