《华为Java语言编码规范方案》由会员分享，可在线阅读，更多相关《华为Java语言编码规范方案（30页珍藏版）》请在金锄头文库上搜索。
1、 Document number 文档编号 Confidentiality level 密级 内部公开Document version 文档版本 Total 29 pages 共 29 页V1.00Java语言编码规范Prepared by 拟制Date日期yyyy-mm-ddReviewed by 评审人Date日期yyyy-mm-ddApproved by批准Date日期yyyy-mm-ddRevision Record 修订记录Date日期Revision Version修订版本Sec No. 修改章节Change Description修改描述Author作者yyyy-mm-ddVx.
2、xxTable of Contents 目录1.范围42.规范性引用文件43.术语和定义44.排版规范54.1.规则54.2.建议75.注释规范85.1.规则85.2.建议136.命名规范166.1.规则166.2.建议177.编码规范197.1.规则197.2.建议238.JTEST规范258.1.规则258.2.建议26 1. 范围本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。本规范适用于使用Java语言编程的产品和项目。2. 规范性引用文件下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或
3、修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。序号编号名称1公司- DKBA1040-2001.12Java语言编程规范3. 术语和定义规则：编程时强制必须遵守的原则。建议：编程时必须加以考虑的原则。格式：对此规范格式的说明。说明：对此规范或建议进行必要的解释。示例：对此规范或建议从正、反两个方面给出例子。4. 排版规范4.1. 规则4.1.1. *程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。4.1.2. *分界符（如大括号和）应各独占一行并且位于同一
4、列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例：如下例子不符合规范。for (.) . / program codeif (.) . / program code void example_fun( void ) . / program code 应如下书写：for (.) . / program codeif (.) . / program codevoid example_fun( void ) . / program code4.1.3. *较长的语句、表达式或参数（80字
5、符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例：if (filename != null & new File(logPath + filename).length() LogConfig.getFileSize() . / program codepublic static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum)4.1.4. *
6、不允许把多个短语句写在一行中，即一行只写一条语句示例：如下例子不符合规范。LogFilename now = null; LogFilename that = null;应如下书写：LogFilename now = null;LogFilename that = null;4.1.5. *if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号。示例：如下例子不符合规范。if(writeToFile) writeFileThread.interrupt();应如下书写：if(w
7、riteToFile)writeFileThread.interrupt();4.1.6. *相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if(log.getLevel() LogConfig.getRecordLevel() return;LogWriter writer;应如下书写：if(log.getLevel() LogConfig.getRecordLevel()return;LogWriter writer;int index;4.1.7. *对齐只使用空格键，不使用TAB键。说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布
8、局不整齐。JBuilder、UltraEdit等编辑环境，支持行首TAB替换成空格，应将该选项打开。4.1.8. *在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在Java语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清
9、晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例：（1） 逗号、分号只在后面加空格。int a, b, c; （2） 比较操作符, 赋值操作符=、 +=，算术操作符+、%，逻辑操作符&、&，位域操作符= 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等关键
10、字更为突出、明显。if (a = b & c d)4.2. 建议类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。格式：类定义类的公有属性定义类的保护属性定义类的私有属性定义类的公有方法定义类的保护方法定义类的私有方法定义5. 注释规范5.1. 规则5.1.1. 一般情况下，源程序有效注释量必须在30以上。说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。5.1.2. 包的注释：包的注释写入一名为 package.html 的HTML格式说明文件放入当前路径。说明：方便JavaD
11、oc收集示例：com/huawei/msg/relay/comm/package.html5.1.3. 包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。说明：在详细描述中应该说明这个包的作用以及在整个项目中的位置。格式：一句话简述。详细描述。产品模块名称和版本公司版权信息示例：为 Relay 提供通信类，上层业务使用本包的通信类与SP进行通信。详细描述。MMSC V100R002 Relay(C) 版权所有 2002-2007 文思创新技术有限公司5.1.4. 文件注释：文件注释写入文件头部，包名之前的位置。说明：注意以 /* 开始避免被 JavaDoc 收集示
12、例：/* * 注释内容 */package m;5.1.5. 文件注释内容：版权说明、描述信息、生成日期、修改历史。说明：文件名可选。格式：/* * 文件名：文件名 * 版权：版权 * 描述：描述 * 修改人：修改人 * 修改时间：YYYY-MM-DD * 修改单号：修改单号 * 修改内容：修改内容 */说明：每次修改后在文件头部写明修改信息，CheckIn的时候可以直接把蓝色字体信息粘贴到VSS的注释上。在代码受控之前可以免去。示例：/* * 文件名：LogManager.java * 版权：Copyright 2002-2007 Huawei Tech. Co. Ltd. All Rights Reserved. * 描述： MMSC V100R002 Relay 通用日志系统 * 修改人： 张三 * 修改时间：2001-02-16 * 修改内容：新增 * 修改人： 李四 * 修改时间：2001-02-26 * 修改单号：WSS368 * 修改内容：。 * 修改人： 王五 * 修改时间：2001-03-25 * 修改单号：WSS498 * 修改内容：。 */5.1.6. 类和接口的注释：该注释放在 package 关键字之后，class 或者 interface 关键字之前。说明：方便JavaDoc收集。示例：package m;/* * 注释内容 */publi
