Java语言编程规范华为.docxVIP

精心整理 精心整理 \ \ I \ \ I DKBA 华为技术有限公司企业技术规范 DKBA1040-2001.12 DKBA1040-2001.12 代替(DKBA200106-003) Java语言编程规范 2001-12-XX 发布 2001-12-XX 实施 华为技术有限公司发布 \ \ X, f \ 1 X 目次 刖 TOC \o 1-5 \h \z 言 3 1范围 11 2规范性引用文件 11 \o Current Document 3术语和定义 11 4排版规范 12 \o Current Document 4.1规则 12 *程序块要采用缩进风格编写，缩进的空格数为 4个。 12 *分界符（如大括号 ‘和‘应各独占一行并且位于同一列，同时与 12 引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及 if、 for、do、while 、switch 、case语句中的程序都要采用如上的缩进 方式。 *较长的语句、表达式或参数（＞80字符）要分成多行书写，长 13 表达式要在低优先级操作符处划分新行，操作符放在新行之 首，划分出的新行要进行适当的缩进，使排版整齐，语句可 读。 *不允许把多个短语句写在一行中，即一行只写一条语句 13 *if,for,do,while,case,switch,default 等语句自占一行，且 13 if,for,do,while 等语句的执行语句无论多少都要加括号｛｝。 *相对独立的程序块之间、变量说明之后必须加空行。 13 *对齐只使用空格键，不使用 TAB键。 14 *在两个以上的关键字、变量、常量进行对等操作时，它们之间的操 14 作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密 切的立即操作符（如.），后不应加空格。 \o Current Document 4.2建议 15 类属性和类方法不要交叉放置，不同存取范围的属性或者方 15 法也尽量不要交叉放置。 5注释规范 16 \o Current Document 5.1规则 16 一般情况下，源程序有效注释量必须在 30 %以上。 16 包的注释：包的注释写入一个名为 package.html的HTML格式的说明文 16 件放入当前路径。 包的注释内容：简述本包的作用、详细描述本包的内容、产 16 品模块名称和版本、公司版权。 文件注释：文件注释写入文件头部，包名之前的位置。 16 文件注释内容：版权说明、描述信息、生成日期、修改历史 。 17 类和接口的注释：该注释 放在package关键字之后，class或者 18 in terface 关键字之前。 TOC \o 1-5 \h \z 类和接口的注释内容：类的注释 主要是一句话功能简述、功能详 18 细描述， 类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。 19 成员变量注释内容：成员变量的 意义、目的、功能，可能被用到的地 19 方。 公有和保护方法注释内容：列出方法的一句话功能简述、功能详 19 细描述、输入参数、输出参数、返回值、违例等。 对于方法内部用throw语句抛出的异常，必须在方法的注释中 20 标明，对于所调用的其他方法所抛出的异常，选择主要的在注 释中说明。对于非 RuntimeException ，即throws子句声明会抛出 的异常，必须在方法的注释中标明。 *注释应与其描述的代码相近，对代码的注释应放在其上方或右方 20 （对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其 上面的代码用空行隔开。 *注释与所描述内容进行同样的缩排。 20 *将注释与其上面的代码用空行隔开。 21 *对变量的定义和分支语句（条件分支、循环语句等）必须编写注 21 释。 *对于switch 语句下的case语句，如果因为特殊情况需要处理完一 21 个case后进入下一个case处理，必须在该 case语句处理完、下一个 case语句前加上明确的注释。 *边写代码边注释，修改代码同时修改相应的注释，以保证注释与代 21 码的一致性。不再有用的注释要删除。 *注释的内容要清楚、明了，含义准确，防止注释二义性。 21 *避免在注释中使用缩写，特别是不常用缩写。 21 5.1建议 21 *避免在一行代码或表达式的中间插入注释。 22 *通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结 22 构，使代码成为自注释的。 *在代码的功能、意图层次上进行注释，提供有用、额外的信息。 22 *在程序块的结束行右方加注释标记，以表明某程序块的结束。 22 *注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼 22 有的，建议多使用中文，除非能用非常流利准确的英文表达。 方法内的单行注释使用//。 2