华为项目编程规范

DKBA 华为技术有限公司企业技术规范 DKBAXXXX-2001.12 代替（DKBA200106-003） Java语言编程规范 2001-12-XX发布 2001-12-XX实施 华 为 技 术 有 限 公 司发布 目 次 前言 ..............................................................................................................................................................3 1 范围 11 2 规范性引用文件 11 3 术语和定义 11 4 排版规范 12 4.1 规则 12 1.*程序块要采用缩进风格编写，缩进的空格数为4个。 12 2.*分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 12 3.*较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 13 4.*不允许把多个短语句写在一行中，即一行只写一条语句 13 5.*if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号{}。 13 6.*相对独立的程序块之间、变量说明之后必须加空行。 13 7.*对齐只使用空格键，不使用TAB键。 14 8.*在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。 14 4.2 建议 15 1.类属性和类 方法 快递客服问题件处理详细方法山木方法pdf计算方法pdf华与华方法下载八字理论方法下载 不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。 15 5 注释规范 16 5.1 规则 16 1.一般情况下，源程序有效注释量必须在30％以上。 16 2.包的注释：包的注释写入一个名为 package.html 的HTML格式的说明文件放入当前路径。 16 3.包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。 16 4.文件注释：文件注释写入文件头部，包名之前的位置。 16 5.文件注释内容：版权说明、描述信息、生成日期、修改历史。 17 6.类和接口的注释：该注释放在 package 关键字之后，class 或者 interface 关键字之前。 18 7.类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述， 18 8.类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。 19 9. 成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。 19 10.公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。 19 11.对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。 20 12.*注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 20 13.*注释与所描述内容进行同样的缩排。 20 14.*将注释与其上面的代码用空行隔开。 21 15.*对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。 21 16.*对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。 21 17.*边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。 21 18.*注释的内容要清楚、明了，含义准确，防止注释二义性。 21 19.*避免在注释中使用缩写，特别是不常用缩写。 21 5.1 建议 21 1.*避免在一行代码或表达式的中间插入注释。 22 2.*通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。 22 3.*在代码的功能、意图层次上进行注释，提供有用、额外的信息。 22 4.*在程序块的结束行右方加注释标记，以表明某程序块的结束。 22 5.*注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。 22 6.方法内的单行注释使用 //。 22 7.注释尽量使用中文注释和中文标点。方法和类描述的第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。接下来的部分可以详细描述。 23 8.顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代码前面进行注释。 23 9. 一些复杂的代码需要说明。 23 6 命名规范 24 6.1 规则 24 1.包名采用域后缀倒置的加上自定义的包名，采用小写字母。在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。 24 2.类名和接口使用类意义完整的英文描述，每个英文 单词 英语单词 下载七年级上册英语单词表下载英语单词表下载深圳小学英语单词表 下载高中英语单词 下载 的首字母使用大写、其余字母使用小写的大小写混合法。 24 3.方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。 24 4.方法中，存取属性的方法采用setter 和 getter方法，动作方法采用动词和动宾结构。 24 5.属性名使用意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同。 25 6.常量名使用全大写的英文描述，英文单词之间用下划线分隔开，并且使用 final static 修饰。 25 7.属性名可以和公有方法参数相同，不能和局部变量相同； 引用非静态成员变量时使用 this 引用，引用静态成员变量时使用类名引用。 25 6.2 建议 25 1.常用组件类的命名以组件名加上组件类型名结尾。 25 2.如果函数名超过15个字母，可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。 26 3.准确地确定成员函数的存取控制符号，不是必须使用 public 属性的，请使用 protected，不是必须使用 protected, 请使用 private。 26 4.含有集合意义的属性命名，尽量包含其复数的意义。 26 7 编码规范 27 7.1 规则 27 1.*明确方法功能，精确（而不是近似）地实现方法 设计 领导形象设计圆作业设计ao工艺污水处理厂设计附属工程施工组织设计清扫机器人结构设计 。一个函数仅完成一件功能，即使简单功能也应该编写方法实现。 27 2.应明确规定对接口方法参数的合法性检查应由方法的调用者负责还是由接口方法本身负责， 缺省是由方法调用者负责。 27 3.明确类的功能，精确（而不是近似）地实现类的设计。一个类仅实现一组相近的功能。 27 4.所有的数据类必须重载toString() 方法，返回该类有意义的内容。 27 5.数据库操作、IO操作等需要使用结束close()的对象必须在try -catch-finally 的finally中close()。 27 6.异常捕获后，如果不对该异常进行处理，则应该纪录日志或者ex.printStackTrace() 。 28 7.自己抛出的异常必须要填写详细的描述信息。 28 8.运行期异常使用RuntimeException的子类来表示，不用在可能抛出异常的方法声明上加throws子句。非运行期异常是从Exception继承而来的，必须在方法声明上加throws子句。 29 9.在程序中使用异常处理还是使用错误返回码处理，根据是否有利于程序结构来确定，并且异常和错误码不应该混合使用，推荐使用异常。 29 10.*注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。 29 11.*避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的静态变量来代替。 29 12.数组声明的时候使用 int[] index ，而不要使用 int index[] 。 30 13.调试代码的时候，不要使用 System.out 和 System.err 进行打印，应该使用一个包含统一开关的测试类进行统一打印。 30 ？？？14.用调测开关来切换软件的DEBUG版和正式版，而不要同时存在正式版本和DEBUG版本的不同源文件，以减少维护的难度。 30 7.2建议 30 1.记录异常不要保存exception.getMessage()，而要记录exception.toString()。 30 2.一个方法不应抛出太多类型的异常。 31 3.异常捕获尽量不要直接 catch (Exception ex)，应该把异常细分处理。 31 4.*如果多段代码重复做同一件事情，那么在方法的划分上可能存在问题。 31 5.对于创建的主要的类，最好置入main()函数，包含用于测试那个类的代码 。 31 6.集合中的数据如果不使用了应该及时释放，尤其是可重复使用的集合。 31 7.*源程序中关系较为紧密的代码应尽可能相邻。 31 8.*不要使用难懂的技巧性很高的语句，除非很有必要时。 31 8 JTEST规范 32 8.1 规则（1-2 级） 32 1.在switch 中每个 case 语句都应该包含 break 或者 return 。 32 2.不要使用空的for 、if 、while 语句。 32 3.在运算中不要减小数据的精度。 32 4.switch 语句中的 case 关键字要和后面的常量保持一个空格，switch 语句中不要定义case 之外的无用标签。 32 5.不要在if 语句中使用等号= 进行赋值操作。 32 6.静态成员或者方法使用类名访问，不使用句柄访问。 32 7.方法重载的时候，一定要注意方法名相同，避免类中使用两个非常相似的方法名。 32 ？？？8.不要在ComponentListener.componentResized() 方法中调用 serResize() 方法。 32 9.不要覆盖父类的静态方法和私有方法。 32 10.不要覆盖父类的属性。 32 11.不要使用两级以上的内部类。 32 12.把内部类定义成私有类。 32 13.去掉接口中多余的定义（不使用 public, abstract, static, final 等，这是接口中默认的）。 32 14.不要定义不会被用到的局部变量、类私有属性、类私有方法和方法参数。 32 15.显式初始化所有的静态属性。 32 16.不要使用 System.getenv() 方法。 32 17.不要硬编码 ‘\n’和‘\r’作为换行符号。 32 18.不要直接使用 java.awt.peer.* 里面的接口。 32 * * *19.使用 System.arraycopy() ，不使用循环来复制数组。 32 20.避免不必要的 instanceof 比较运算和类造型运算。 32 21.不要在 finalize() 方法中删除监听器（Listeners）。 32 * * *22.在 finalize() 方法中一定要调用 super.finalize() 方法。 32 23.在 finalize() 方法中的 finally 中调用 super.finalize() 方法。 32 24.进行字符转换的时候应该尽可能的较少临时变量。 32 * * *25.使用ObjectStream 的方法后，调用reset() ，释放对象。 32 * * *26.线程同步中，在循环里面使用条件测试（使用 while(isWait) wait() 代替 if(isWait) wait()）。 32 * * *27.不掉用 Thread 类的 resume(), suspend(), stop() 方法。 32 28.减小单个方法的复杂度，使用的 if, while, for, switch 语句要在10个以内。 32 29.在Servlets中，重用JDBC连接的数据源。 32 30.减少在Sevlets中使用的同步方法。 32 31.不定义在包中没有被用到的友好属性、方法和类。 32 * * *32.没有子类的友好类应该定义成 final 。 32 * * *33.没有被覆盖的友好方法应该定义成 final 。 32 8.2 建议（3级或以上） 33 1.为 switch 语句提供一个 default 选项。 33 2.不要在 for 循环体中对计数器的赋值。 33 3.不要给非公有类定义 public 构建器。 33 4.不要对浮点数进行比较运算，尤其是不要进行 ==, !=运算，减少 >, < 运算。 33 * * *5.实现 equals() 方法时，先用 getClass() 或者 instanceof 进行类型比较，通过后才能继续比较。 33 6.不要重载 main() 方法用作除入口以外的其他用途。 33 7.方法的参数名不要和类中的方法名相同。 33 8.除了构建器外，不要使用和类名相同的方法名。 * * *9.不要定义 Error 和 RuntimeException 的子类，可以定义 Exception 的子类。 33 10.线程中需要实现 run() 方法。 33 11.使用 equals() 比较两个类的值是否相同。 33 12.字符串和数字运算结果相连接的时候，应该把数字运算部分用小括号括起来。 33 * * *13.类中不要使用非私有（公有、保护和友好）的非静态属性。 33 14.在类中对于没有实现的接口，应该定义成抽象方法，类应该定义成抽象类。（5级） 33 15.不要显式导入 java.lang.* 包； 33 16.初始化时不要使用类的非静态属性。 33 17.显式初始化所有的局部变量。 33 18.按照方法名把方法排序放置，同名和同类型的方法应该放在一起。 33 19.不要使用嵌套赋值，即在一个表达式中使用多个 = 。 33 20.不要在抽象类的构建器中调用抽象方法。 33 21.重载 equals() 方法的同时，也应该重载 hashCode() 方法。 33 22.工具类（Utility）不要定义构建器，包括私有构建器。 33 23.不要在 switch 中使用10个以上的 case 语句。 33 24.把 main() 方法放在类的最后。 33 25.声明方法违例的时候不要使用 Exception ，应该使用它的子类。 33 26.不要直接扔出一个Error ，应该扔出它的子类。 33 27.在进行比较的时候，总是把常量放在同一边（都放在左边或者都放在右边）。 33 28.在可能的情况下，总是为类定义一个缺省的构建器。 33 29.在捕获违例的时候，不使用 Exception, RuntimeException, Throwable，尽可能使用它们的子类。 33 30.在接口或者工具类中中定义常量。（5级） 33 31.使用大写‘L’表示 long 常量。（5级） 33 32.main() 方法必须是 public static void main(String[])。（5级） 33 33.对返回类型为 boolean 的方法使用 is 开头，其它类型的不能使用。 33 34.对非boolean类型取值方法（getter）使用 get 开头，其它类型的不能使用。 33 35.对于设置值的方法（setter）使用 set 开头，其它类型的不能使用。 33 36.方法需要有同样数量参数的注释 @param。 34 37.不要在注释中使用不支持的标记，如：@unsupported 。 34 38.不要使用 Runtime.exec() 方法。 34 39.不要自定义本地方法（native method）。 34 40.使用尽量简洁的的运算符号。 34 41.使用集合时设置初始容量。 34 42.单个首字符的比较使用 charAt() 而不用 startsWith() 。 34 43.对于被除数或者被乘数为2的n次方的乘除运算使用移位运算符 >>, << 。 34 44.一个字符的连接使用‘ ’而不使用 “ ”，如：String a = b + 'c'。 34 45.不要在循环体内调用同步方法和使用 try-catch 块。 34 46.不要使用不必要的布尔值比较，如：if (a.equals(b)), 而不是 if (a.equals(b)==true)。 34 47.常量字符串使用 String, 非常量字符串使用 StringBuffer。 34 48.在循环条件判断的时候不要使用复杂的表达式。 49.对于“if (condition) do1; else do2;”语句使用条件操作符“if (condition)?do1:do2;”。 34 50.不要在循环体内定义变量。 34 51.使用StringBuffer的时候设置初始容量。 34 52.尽可能的使用局部变量进行运算。 34 53.尽可能少的使用 ‘!’操作符。（5级） 34 54.尽可能的对接口进行 instanceof 运算。（5级） 34 55.不要使用 Date[] 而要使用 long[] 替代。 34 56.不要显式调用 finalize() 。 34 57.不要使用静态集合，其内存占用增长没有边界。 34 58.不要重复调用一个方法获取对象，使用局部变量重用对象。 34 59.线程同步中，使用 notifyAll() 代替 notify()。 34 60.避免在同步方法中调用另一个同步方法造成的死锁。 34 61.非同步方法中不能调用 wait() , notify() 方法。 34 62.使用 wait(), notify() 代替 while(), sleep() 。 34 63.不要使用同步方法，使用同步块。（5级） 34 64.把所有的公有方法定义为同步方法。 （5级） 34 65.实现的 Runnable.run() 方法必须是同步方法。 （5级） 34 66.一个只有abstract方法、final static 属性的类应该定义成接口。 34 67.在 clone() 方法中应该而且必须使用 super.clone() 而不是 new 。 34 68.常量必须定义为 final 。 34 69.在 for 循环中提供终止条件。 34 70.在 for, while 循环中使用增量计数。 34 71.使用 StringTokenizer 代替 indexOf() 和 substring() 。 34 72.不要在构建器中使用非 final 方法。 34 73.不要对参数进行赋值操作。（5级） 35 74.不要通过名字比较两个对象的类，应该使用 getClass() 。 35 75.安全：尽量不要使用内部类。 35 76.安全：尽量不要使类可以克隆。 35 77.安全：尽量不要使接口可以序列化。 35 78.安全：尽量不要使用友好方法、属性和类。 35 79.Servlet：不要使用 java.beans.Beans.instantiate() 方法。 35 80.Servlet：不再使用HttpSession时，应该尽早使用 invalidate() 方法释放 。 35 81.Servlet：不再使用JDBC资源时，应该尽早使用 close() 方法释放 。 35 82.Servlet：不要使用Servlet的 SingleThreadModel，会消耗大量资源。 35 83.国际化：不要使用一个字符进行逻辑操作，使用 Characater。 35 84.国际化：不要进行字符串连接操作，使用MessageFormat 。 35 85.国际化：不要使用 Date.toString() ，Time.toString() 方法。 35 86.国际化：字符和字符串常量应该放在资源文件中。 35 87.国际化：不要使用数字的 toString() 方法。 35 88.国际化：不要使用 StringBuffer , StringTokenizer类。 35 89.国际化：不要使用 String 类的 compareTo(), equals() 方法。 90.复杂度：建议的最大规模： 35 1 参考文献 36 前 言 本规范是参考公司的《软件编程规范总则》和SUN公司《Java Coding Style Guide》结合而成的Java语言编程规范。本规范没有涉及到的相关部分，请参见《软件编程规范总则》。 本规范由OMC与网管研究管理部，智能业务研究管理部提出。 本规范主要起草和解释部门：OMC与网管研究管理部，智能业务研究管理部 本规范主要起草人：易雄志，张晋，李大伟，傅贵，童志刚，望岳 本规范主要审核人： 本规范批准人： 本规范规范所替代的历次修订情况和修订人为： 智能业务部对本规范的以下方面进行了补充和完善：1、排版规范，2、注释规范，3、命名规范，4、编码规范，5、JTEST规范。并且按照最新模版进行重新排版。 Java语言编程规范 1​  范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。 本规范适用于使用Java语言编程的部门和产品。 2​  规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达成 协议 离婚协议模板下载合伙人协议 下载渠道分销协议免费下载敬业协议下载授课协议下载 的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。 序号 编号 名称 1 公司-0000 《软件编程规范总则》 同总则的部分使用*号 2 公司-DKBA200106-003 《Java语言编程规范》 1​  术语和定义 规则：编程时强制必须遵守的原则。 建议：编程时必须加以考虑的原则。 格式：对此规范格式的说明。 说明：对此规范或建议进行必要的解释。 示例：对此规范或建议从正、反两个方面给出例子。 2​  排版规范 .1​  规则 1. *程序块要采用缩进风格编写，缩进的空格数为4个。 说明：对于由开发工具自动生成的代码可以有不一致。 2. *分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 示例：如下例子不符合规范。 for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code } 应如下书写。 for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code } 3. *较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例： if (filename != null && new File(logPath + filename).length() < LogConfig.getFileSize()) { ... // program code } public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum) 4. *不允许把多个短语句写在一行中，即一行只写一条语句 示例：如下例子不符合规范。 LogFilename now = null; LogFilename that = null; 应如下书写 LogFilename now = null; LogFilename that = null; 5. *if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号{}。 示例：如下例子不符合规范。 if(writeToFile) writeFileThread.interrupt(); 应如下书写： if(writeToFile) { writeFileThread.interrupt(); } 6. *相对独立的程序块之间、变量说明之后必须加空行。 示例：如下例子不符合规范。 if(log.getLevel() < LogConfig.getRecordLevel()) { return; } LogWriter writer; 应如下书写 if(log.getLevel() < LogConfig.getRecordLevel()) { return; } LogWriter writer; int index; 7. *对齐只使用空格键，不使用TAB键。 说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐。JBuilder、UltraEdit等编辑环境，支持行首TAB替换成空格，应将该选项打开。 8. *在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。 说明：采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在Java语言中括号已经是最清晰的 标志 禁止坐卧标志下载饮用水保护区标志下载桥隧标志图下载上坡路安全标志下载地理标志专用标志下载 了。 在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。 示例： (1) 逗号、分号只在后面加空格。 int a, b, c; (2)比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。 if (current_time >= MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2; (3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。 flag = !isEmpty; // 非操作"!"与内容之间 i++; // "++","--"与内容之间 (4)"."前后不加空格。 p.id = pid; // "."前后不加空格 (5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。 if (a >= b && c > d) .2​  建议 1. 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。 格式： 类定义 { 类的公有属性定义 类的保护属性定义 类的私有属性定义 类的公有方法定义 类的保护方法定义 类的私有方法定义 } 3​  注释规范 .1​  规则 1. 一般情况下，源程序有效注释量必须在30％以上。 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。 2. 包的注释：包的注释写入一个名为 package.html 的HTML格式的说明文件放入当前路径。 说明：方便JavaDoc收集 示例： com/huawei/iin/websmap/comm/package.html 3. 包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。 说明：在详细描述中应该说明这个包的作用以及在整个项目中的位置。 格式：

一句话简述。

详细描述。

产品模块名称和版本
公司版权信息 示例：

为 WEBSMAP 提供通信类，上层业务使用本包的通信类与 SMP-B 进行通信。

详细描述。。。。。。。。

IIN V100R001 WEBSMAP
(C) 版权所有 2000-2001 华为技术有限公司 .1​ 文件注释：文件注释写入文件头部，包名之前的位置。 说明：注意以 /* 开始避免被 JavaDoc 收集 示例： /* * 注释内容 */ package com.huawei.iin.websmap.comm; 1. 文件注释内容：版权说明、描述信息、生成日期、修改历史。 说明：文件名可选。 格式： /* * 文件名：[文件名] * 版权：〈版权〉 * 描述：〈描述〉 * 修改人：〈修改人〉 * 修改时间：YYYY-MM-DD * 跟踪单号：〈跟踪单号〉 * 修改单号：〈修改单号〉 * 修改内容：〈修改内容〉 */ 说明：每次修改后在文件头部写明修改信息，CheckIn的时候可以直接把蓝色字体信息粘贴到VSS的注释上。在代码受控之前可以免去。 示例： /* * 文件名：LogManager.java * 版权：Copyright 2000-2001 Huawei Tech. Co. Ltd. All Rights Reserved. * 描述： WIN V200R002 WEBSMAP 通用日志系统 * 修改人： 张三 * 修改时间：2001-02-16 * 修改内容：新增 * 修改人： 李四 * 修改时间：2001-02-26 * 跟踪单号：D20103 * 修改单号：WSS368 * 修改内容：。。。。。。 * 修改人： 王五 * 修改时间：2001-03-25 * 跟踪单号：D27153 * 修改单号：WSS498 * 修改内容：。。。。。。 */ 2. 类和接口的注释：该注释放在 package 关键字之后，class 或者 interface 关键字之前。 说明：方便JavaDoc收集 示例： package com.huawei.iin.websmap.comm; /** * 注释内容 */ public class CommManager 3. 类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述， 说明：可根据需要列出：版本号、生成日期、作者、内容、功能、与其它类的关系等。 如果一个类存在Bug，请如实说明这些Bug。 格式： /** * 〈一句话功能简述〉 * 〈功能详细描述〉 * @author [作者] * @version [版本号, YYYY-MM-DD] * @see [相关类/方法] * @since [产品/模块版本] * @deprecated */ 说明：描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，@since 表示从那个版本开始就有这个类或者接口，@deprecated 表示不建议使用该类或者接口。 示例： /** * LogManager 类集中控制对日志读写的操作。 * 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器， * 读取或写入符合条件的日志纪录。 * @author 张三，李四，王五 * @version 1.2, 2001-03-25 * @see LogIteraotor * @see BasicLog * @since CommonLog1.0 */ 4. 类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。 示例： /** * 注释内容 */ private String logType; /** * 注释内容 */ public void write() 5. 成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。 6. 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。 格式： /** * 〈一句话功能简述〉 * 〈功能详细描述〉 * @param [参数1] [参数1说明] * @param [参数2] [参数2说明] * @return [返回类型说明] * @exception/throws [违例类型] [违例说明] * @see [类、类#方法、类#成员] * @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 CommonLog1.0 */ public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum) 7. 对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。 说明：异常注释用@exception或@throws表示，在JavaDoc中两者等价，但推荐用@exception标注Runtime异常，@throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。 8. *注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 9. *注释与所描述内容进行同样的缩排。 说明：可使程序排版整齐，并方便注释的阅读与理解。 示例：如下例子，排版不整齐，阅读稍感不方便。 public void example( ) { // 注释 CodeBlock One // 注释 CodeBlock Two } 应改为如下布局。 public void example( ) { // 注释 CodeBlock One // 注释 CodeBlock Two } 10. *将注释与其上面的代码用空行隔开。 示例：如下例子，显得代码过于紧凑。 //注释 program code one //注释 program code two 应如下书写： //注释 program code one //注释 program code two 11. *对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。 说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。 12. *对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。 说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。 13. *边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。 14. *注释的内容要清楚、明了，含义准确，防止注释二义性。 说明：错误的注释不但无益反而有害。 15. *避免在注释中使用缩写，特别是不常用缩写。 说明：在使用缩写时或之前，应对缩写进行必要的说明。 .2​  建议 1. *避免在一行代码或表达式的中间插入注释。 说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。 2. *通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。 说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。 3. *在代码的功能、意图层次上进行注释，提供有用、额外的信息。 说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。 示例：如下注释意义不大。 // 如果 receiveFlag 为真 if (receiveFlag) 而如下的注释则给出了额外有用的信息。 // 如果从连结收到消息 if (receiveFlag) 4. *在程序块的结束行右方加注释标记，以表明某程序块的结束。 说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。 示例：参见如下例子。 if (...) { program code1 while (index < MAX_INDEX) { program code2 } // end of while (index < MAX_INDEX) // 指明该条while语句结束 } // end of if (...) // 指明是哪条if语句结束 5. *注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。 说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。 6. 方法内的单行注释使用 //。 说明：调试程序的时候可以方便的使用 /* 。。。*/ 注释掉一长段程序。 7. 注释尽量使用中文注释和中文标点。方法和类描述的第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。接下来的部分可以详细描述。 说明：JavaDoc工具收集简介的时候使用选取第一句话。 8. 顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代码前面进行注释。 示例：如下是对设置属性的流程注释 //1、 判断输入参数是否有效。 。。。。。 // 2、设置本地变量。 。。。。。。 9. 一些复杂的代码需要说明。 示例：这里主要是对闰年算法的说明。 //1. 如果能被4整除，是闰年； //2. 如果能被100整除，不是闰年.； //3. 如果能被400整除，是闰年.。 4​  命名规范 .1​  规则 1. 包名采用域后缀倒置的加上自定义的包名，采用小写字母。在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。 格式： com.huawei.产品名.模块名称 com.huawei.部门名称. 项目名称 示例： 融合WEBSMAP包名 com.huawei.iin.websmap 通用消息转发包名 com.huawei.insa2.msgtrans 2. 类名和接口使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。 示例：OrderInformation, CustomerList, LogManager, LogConfig, SmpTransaction 3. 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。 示例： private void calculateRate(); public void addNewOrder(); 4. 方法中，存取属性的方法采用setter 和 getter方法，动作方法采用动词和动宾结构。 格式： get + 非布尔属性名() is + 布尔属性名() set + 属性名() 动词() 动词 + 宾语() 示例： public String getType(); public boolean isFinished(); public void setVisible(boolean); public void show(); public void addKeyListener(Listener); 5. 属性名使用意义完整的英文描述：第一个单词的字母使用小写(和方法命名一样)、剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同。 示例： private customerName; private orderNumber; private smpSession; 6. 常量名使用全大写的英文描述，英文单词之间用下划线分隔开，并且使用 final static 修饰。 示例： public final static int MAX_VALUE = 1000; public final static String DEFAULT_START_DATE = "2001-12-08"; ##7. 属性名可以和公有方法参数相同，不能和局部变量相同，引用非静态成员变量时使用 this 引用，引用静态成员变量时使用类名引用。 示例： public class Person { private String name; private static List properties; public void setName (String name) { this.name = name; } public void setProperties (List properties) { Person.properties = properties; } .2​  建议 1. 常用组件类的命名以组件名加上组件类型名结尾。 示例： Application 类型的，命名以App 结尾——MainApp Frame 类型的，命名以Frame 结尾——TopoFrame Panel 类型的，建议命名以Panel 结尾——CreateCircuitPanel Bean 类型的，建议命名以Bean 结尾——DataAccessBean EJB 类型的，建议命名以EJB 结尾——DBProxyEJB Applet 类型的，建议命名以Applet 结尾——PictureShowApplet 2. 如果函数名超过15 个字母，可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。 示例：getCustomerInformation() 改为 getCustomerInfo() 3. 准确地确定成员函数的存取控制符号，不是必须使用 public 属性的，请使用 protected，不是必须使用 protected, 请使用 private。 示例： protected void setUserName(), private void calculateRate() 4. 含有集合意义的属性命名，尽量包含其复数的意义。 示例：customers, orderItems 5​  编码规范 .1​  规则 1. *明确方法功能，精确（而不是近似）地实现方法设计。一个函数仅完成一件功能，即使简单功能也应该编写方法实现。 说明：虽然为仅用一两行就可完成的功能去编方法好象没有必要，但用方法可使功能明确化，增加程序可读性，亦可方便维护、测试。 2. 应明确规定对接口方法参数的合法性检查应由方法的调用者负责还是由接口方法本身负责，缺省是由方法调用者负责。 说明：对于模块间接口方法的参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患；要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。 3. 明确类的功能，精确（而不是近似）地实现类的设计。一个类仅实现一组相近的功能。 说明：划分类的时候，应该尽量把逻辑处理、数据和显示分离，实现类功能的单一性。 示例： 数据类不能包含数据处理的逻辑。 通信类不能包含显示处理的逻辑。 4. 所有的数据类必须重载toString() 方法，返回该类有意义的内容。 说明： 父类如果实现了比较合理的toString() ，子类可以继承不必再重写。 示例： public TopoNode { private String nodeName; public String toString() { return "NodeName : " + nodeName; } } 5. 数据库操作、IO操作等需要使用结束close()的对象必须在try -catch-finally 的finally中close()。 示例： try { // ... ... } catch(IOException ioe) { //... ... } finally { try { out.close(); } catch (IOException ioe) { //... ... } } 6. 异常捕获后，如果不对该异常进行处理，则应该纪录日志或者ex.printStackTrace() 。 说明：若有特殊原因必须用注释加以说明。 示例： try { //.... ... } catch (IOException ioe) { ioe.printStackTrace (); } 7. 自己抛出的异常必须要填写详细的描述信息。 说明：便于问题定位。 示例： throw new IOException("Writing data error! Data: " + data.toString()); 8. 运行期异常使用RuntimeException的子类来表示，不用在可能抛出异常的方法声明上加throws子句。非运行期异常是从Exception继承而来的，必须在方法声明上加throws子句。 说明： 非运行期异常是由外界运行环境决定异常抛出条件的异常，例如文件操作，可能受权限、磁盘空间大小的影响而失败，这种异常是程序本身无法避免的，需要调用者明确考虑该异常出现时该如何处理方法，因此非运行期异常必须有throws子句标出，不标出或者调用者不捕获该类型异常都会导致编译失败，从而防止程序员本身疏忽。 运行期异常是程序在运行过程中本身考虑不周导致的异常，例如传入错误的参数等。抛出运行期异常的目的是防止异常扩散，导致定位困难。因此在做异常体系设计时要根据错误的性质合理选择自定义异常的继承关系。 还有一种异常是Error 继承而来的，这种异常由虚拟机自己维护，表示发生了致命错误，程序无法继续运行例如内存不足。我们自己的程序不应该捕获这种异常，并且也不应该创建该种类型的异常。 9. 在程序中使用异常处理还是使用错误返回码处理，根据是否有利于程序结构来确定，并且异常和错误码不应该混合使用，推荐使用异常。 说明： 一个系统或者模块应该统一规划异常类型和返回码的含义。 但是不能用异常来做一般流程处理的方式，不要