技术部Java编码规范.docxVIP

PAGE \* MERGEFORMAT 7 Chinapay技术部Java编码规范 （Version: 0.14）  版本变迁记录： 版本号 修改人 时间 修改内容 备注 V0.10 钱斌 2010-06-28 创建文档初稿 V0.11 钱斌 2010-07-07 增加bug和性能优化的注释说明 禁忌中增加对第三方api引入的说明 根据周翔的建议增加 V0.12 钱斌 2010-07-07 增加对大括号换行的说明。 增加对标识符的cp标识的说明 根据周雪松建议增加 V0.13 钱斌 2010-07-08 增加对jar包的说明。 增加配置文件的规范说明 V0.14 钱斌 2010-07-08 修改jar包的发布说明  目录 TOC \o 1-3 \h \z \u HYPERLINK \l _Toc Chinapay技术部Java编码规范 PAGEREF _Toc \h 1 HYPERLINK \l _Toc 1. 概述 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 2. 源程序编程规范 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 2.1. 命名规范 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 2.1.1. 类和接口的命名 PAGEREF _Toc \h 4 HYPERLINK \l _Toc 2.1.2. 方法的命名 PAGEREF _Toc \h 5 HYPERLINK \l _Toc 2.1.3. 变量的命名 PAGEREF _Toc \h 5 HYPERLINK \l _Toc 2.1.3.1. 静态常量的命名 PAGEREF _Toc \h 5 HYPERLINK \l _Toc 2.1.3.2. 枚举的命名 PAGEREF _Toc \h 6 HYPERLINK \l _Toc 2.1.3.3. 普通变量的命名 PAGEREF _Toc \h 6 HYPERLINK \l _Toc 2.1.4. 包的命名 PAGEREF _Toc \h 6 HYPERLINK \l _Toc 2.1.5. Jsp文件及变量的命名 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 2.2. 注释及空白规范 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 2.2.1. 注释规范 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 2.2.2. Java doc规范 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 2.2.3. 空白的规范 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 2.2.3.1. 空行的规范 PAGEREF _Toc \h 7 HYPERLINK \l _Toc 2.2.3.2. 空格的规范 PAGEREF _Toc \h 8 HYPERLINK \l _Toc 2.2.3.3. 缩进的规范 PAGEREF _Toc \h 8 HYPERLINK \l _Toc 2.2.3.4. 折行、换行规范 PAGEREF _Toc \h 8 HYPERLINK \l _Toc 3. 日志规范 PAGEREF _Toc \h 9 HYPERLINK \l _Toc 4. 异常处理的规范 PAGEREF _Toc \h 9 HYPERLINK \l _Toc 5 单元测试规范 PAGEREF _Toc \h 9 HYPERLINK \l _Toc 6 其他禁忌 PAGEREF _Toc \h 10  概述 本标准定义了chinapay技术部java语言开发的编程格式规范，主要包括命名规范、代码注释、日志、以及常用语句的书写要求和约束等。 统一规范的格式有利于代码标准化、提高代码的可读性，从而方便后面维护人员对系统业务流程的理解，便于对系统的进行改造和功能扩展。 适用对象包括java源程序和jsp代码。 源程序编程规范 命名规范 所有的标识符的命名力求做到统一、达意和简洁。如下为标识符的总原则，本章节的所有不同类型的标识符都必须首先符合本原则： 统一：对于同一个概念，在程序中用同一种表示方法。比如对于金额，如果定义了amt，则不要再变成其他名称。 达意：标识符能准确的表达出它所代表的意义，比如： BaseOperDBDAO，GenBankFileProcess等。切忌用tmp，server1,server2等之类的命名。 简洁：在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。 骆驼法则：Java中，除了包名，静