Java语言编程规范--华为01年.docx

為 wVr# DKBA华为技术有限公司企业技术规范DKBA1040-(DKBA200106-003)Java语言编程规范2001-12-XX发布2001-12-XX实施华为技术有限公司发布1范围 112规范性引用文件 113术语和定义 114排版规范 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作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。 15类属性和类方法不要交叉放置,不同存取范围的属性或者方 15法也尽量不要交叉放置。5注释规范 16一般情况下,源程序有效注释量必须在 30%以上。 16包的注释:包的注释写入一个名为 的HTML格式的说 16明文件放入当前路径。包的注释内容:简述本包的作用、详细描述本包的内容、产 16品模块名称和版本、公司版权。文件注释:文件注释写入文件头部,包名之前的位置。幷£册吋文件注释内容:版权说明、描述信息、生成日期、修改历史 。 17类和接口的注释:该注释放在package关键字之后,class或者 18interface 关键字之前。类和接口的注释内容:类的注释 主要是一句话功能简述、功能详 18细描述,类属性、公有和保护方法注释:写在类属性、公有和保护方法上面。 19成员变量注释内容:成员变量的 意义、目的、功能,可能被用到的 19地方。公有和保护方法注释内容:列出方法的一句话功能简述、功能详 19细描述、输入参数、输出参数、返回值、违例等。对于方法内部用throw语句抛出的异常,必须在方法的注释中 20标明,对于所调用的其他方法所抛出的异常,选择主要的在注释中说明。 对于非RuntimeException,即throws子句声明会抛出的异常,必须在方法的注释中标明。*注释应与其描述的代码相近,对代码的注释应放在其上方或右方 20(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。*注释与所描述内容进行同样的缩排。 20*将注释与其上面的代码用空行隔开。 21*对变量的定义和分支语句(条件分支、循环语句等)必须编写注 21释。*对于switch语句下的case语句,如果因为特殊情况需要处理完一 21个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。*边写代码边注释,修改代码同时修改相应的注释,以保证注释与代 21码的一致性。不再有用的注释要删除。*注释的内容要清楚、明了,含义准确,防止注释二义性。 21*避免在注释中使用缩写,特别是不常用缩写。 21*避免在一行代码或表达式的中间插入注释。 22*通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结 22构,使代码成为自注释的。*在代码的功能、意图层次上进行注释,提供有用、额外的信息。 22*在程序块的结束行右方加注释标记,以表明某程序块的结束。 22*注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼 22有的,建议多使用中文,除非能用非常流利准确的英文表达。方法内的单行注释使用 //。 22注释尽量使用中文注释和中文标点。方法和类描述的第一句话尽量使 23用简洁明了的话概括一下功能,然后加以句号。接下来的部分可以详细描述。顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代 23码前面进行注释。一些复杂的代码需要说明。 23 彩 £ 6命名规范 24包名采用域后缀倒置的加上自定义的包名,采用小写字母。 24在部门内部应该规划好包名的范围,防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。类名和接口使用类意义完整的英文描述,每个英文单词