软件编码规范总结.docx

Document number 文档编号 Confidentiality level 密级 内部公开 Document version 文档版本 Total 24 pages共 24 页 Java 语言编码规范 Prepared by Date yyyy-mm-dd 拟制 日期 Reviewed by Date yyyy-mm-dd 评审人 日期 Approved by Date yyyy-mm-dd 批准 日期 Revision Record 修订记录 Date  Revision  Sec No.  Change Description  Author 日期  Version  修改章节  修改描述  作者 修订版本 yyyy-mm-dd Table of Contents 目录 1. 范围 错误 !未定义书签。 2. 规范性引用文件 错误 !未定义书签。 3. 术语和定义 错误 !未定义书签。 4. 排版规范 错误 !未定义书签。 . 规则 错误 !未定义书签。 . 建议 错误 !未定义书签。 5. 注释规范 错误 !未定义书签。 . 规则 错误 !未定义书签。 . 建议 错误 !未定义书签。 6. 命名规范 错误 !未定义书签。 . 规则 错误 !未定义书签。 . 建议 错误 !未定义书签。 7. 编码规范 错误 !未定义书签。 . 规则 错误 !未定义书签。 . 建议 错误 !未定义书签。 8. JTEST规范 错误 !未定义书签。 . 规则 错误 !未定义书签。 . 建议 错误 !未定义书签。 范围 本规范规定了使用 Java语言编程时排版、注释、命名、编码和 JTEST的规则和建议。 本规范适用于使用 Java语言编程的产品和项目。 规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。 序号  编号  名称 1  《 Java 语言编程规范》 术语和定义 规则： 编程时强制必须遵守的原则。 建议： 编程时必须加以考虑的原则。 格式： 对此规范格式的说明。 说明： 对此规范或建议进行必要的解释。 示例： 对此规范或建议从正、反两个方面给出例子。 排版规范 4.1. 规则 4.1.1. * 程序块要采用缩进风格编写，缩进的空格数为 4个。 说明：对于由开发工具自动生成的代码可以有不一致。 4.1.2. * 分界符（如大括号‘ { ’和‘ } ’）应各独占一行并且位于同一列，同时与引用它们的 语句左对齐。在函数体的开始、类和接口的定义、以及 if 、 for 、do、while 、 switch 、 case语句中的程序都要采用如上的缩进方式。 示例：如下例子不符合规范。 for (...) { ... .) { ... . .) { ... .) { ... . ength() ()) { 4.1.3. ... ，后不应加空格。 说明：采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格， 如果语句已足够清晰则括号内侧 ( 即左括号后面和右括号前面 ) 不需要加空格，多重括号间不必加 空格，因为在 Java 语言中括号已经是最清晰的标志了。 在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操 作符留空格时不要连续留两个以上空格。 示例： （ 1） 逗号、分号只在后面加空格。 int a, b, c; （ 2） 比较操作符 , 赋值操作符 = 、 += ，算术操作符 + 、% ，逻辑操作符 、 ， 位域操作符 、 ^ 等双目操作符的前后加空格。 if (current_time = MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2; （ 3） ! 、 ~ 、++ 、 -- 、 （地址运算符）等单目操作符前后不加空格。 （ 4） flag = !isEmpty; 前后不加空格。 = pid; 前后不加空格 （ 5） if 、 for 、while 、 switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明 显。 if (a = b c d) 4.2. 建议 类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。 格式： 类定义 { 类的公有属性定义 类的保护属性定义 类的私有属性定义 类的公有方法定义 类的保护方法定义