华为Java语言编码规范.docx

Document number 文档编号 Confidentiality level 密级 内部公开 Document version 文档版本 V1.00 Total 28 pages 共 28 页 Java 语言编码规范 Prepared by 拟制 Date 日期 yyyy-mm-dd Reviewed by 评审人 Date 日期 yyyy-mm-dd Approved by 批准 Date 日期 yyyy-mm-dd Java编码规范 Revision Record 修订记录 Date Revision Sec No. Change Description Author 日期 修改章节 修改描述 作者 Version 修订版本 yyyy-mm-dd Vx.xx . Page 2, Total 28 Java编码规范 Table of Contents 目录 1. 范围 4 2. 规范性引用文件 4 3. 术语和定义 4 4. 排版规范 5 4.1. 规则 5 4.2. 建议 7 5. 注释规范 8 5.1. 规则 8 5.2. 建议 13 6. 命名规范 16 6.1. 规则 16 6.2. 建议 17 7. 编码规范 19 7.1. 规则 19 7.2. 建议 22 8. JTEST 规范 24 8.1. 规则 24 8.2. 建议 25 . Page 3, Total 28 Java编码规范 1. 范围 本规范规定了使用 Java语言编程时排版、注释、命名、编码和 JTEST的规则和建议。 本规范适用于使用 Java语言编程的产品和项目。 2. 规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后 所有的修改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达 成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本 适用于本规范。 序号 编号 名称 1 公司- DKBA1040-2001.12 《Java语言编程规范》 3. 术语和定义 规则： 编程时强制必须遵守的原则。 建议： 编程时必须加以考虑的原则。 格式： 对此规范格式的说明。 说明： 对此规范或建议进行必要的解释。 示例： 对此规范或建议从正、反两个方面给出例子。 . Page 4, Total 28 Java编码规范 4. 排版规范 4.1. 规则 4.1.1. *程序块要采用缩进风格编写，缩进的空格数为 4个。 说明：对于由开发工具自动生成的代码可以有不一致。 4.1.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 } 4.1.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) . Page 5, Total 28 Java编码规范 4.1.4. *不允许把多个短语句写在一行中，即一行只写一条语句 示例：如下例子不符合规范。 LogFilename now = null; LogFilename that = null; 应如下书写： LogFilename now = null; LogFilename that = null; 4.1.5. *if