Java语言编程规范--华为技术有限公司

Java语言编程规范 Java语言编程规范是华为技术有限公司企业技术规范DKBA1040-2001.12的重要组成部分，旨在规范Java语言的编程风格、命名惯例、代码组织、注释等方面。该规范的实施旨在提高Java语言编程的质量、可读性和可维护性。 1. 编程风格 * 程序块要采用缩进风格编写，缩进的空格数为4个。 * 分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。 * 较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 * 不允许把多个短语句写在一行中，即一行只写一条语句。 * if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号{}。 * 相对独立的程序块之间、变量说明之后必须加空行。 * 对齐只使用空格键，不使用TAB键。 2. 注释规范 * 一般情况下，源程序有效注释量必须在30％以上。 * 包的注释：包的注释写入一个名为 package.html 的HTML格式的说明文件放入当前路径。 * 包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。 * 文件注释：文件注释写入文件头部，包名之前的位置。 * 文件注释内容：版权说明、描述信息、生成日期、修改历史。 * 类和接口的注释：该注释放在 package 关键字之后，class 或者 interface 关键字之前。 * 类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述。 * 类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。 * 成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。 * 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。 * 对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 * 对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。 3. 其他规范 * 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。 * 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。 Java语言编程规范旨在规范Java语言的编程风格、命名惯例、代码组织、注释等方面，提高Java语言编程的质量、可读性和可维护性。