AsiaInfo 软件规范 移动客户事业部Java语言编码规范 软件规范 编写 审批 文档版本 编码规范编制小组 V1.9 编写时间 审批时间 2014.8 亚信科技(中国)有限公司版权所有 文档中的全部内容属亚信科技(中国)有限公司所有, 未经允许,不可全部或部分发表、复制、使用于任何目的。
文档修订摘要
日期 修订号 描述 根据各研发中心、及google等参考文档,汇总新建文档,划定制定范围、定文档目录结构;根据目录结构整理各章节规范,命名规范(宫迎宾)、布局规范(周琪宏)、注释规范(郑园园)、语句规范(彭振球)、日志规范(马万平)、异常规范(马万平)。 著者 宫迎宾、周琪宏、郑园园、彭振球、马万平 审阅者 日期 2014-8-4 1 李玉和 2014-8-5 2014-8-6 2 宫迎宾、周琪宏、周园Java组内增减,评审,定草稿版本v0.1。 园、彭振球、马万平 Java,c++,db,web组汇合评审,定草稿v0.2 周琪宏、宫迎宾增加名词解释(驼峰式、K&R, 魔术数字、CAS机制) 对文档格式排版进行统一格式调整。 对文档示例代码格式调整。 周琪宏、宫迎宾 王霄 周琪宏 李玉和 2014-8-6 2014-8-7 2014-8-7 2014-8-7 2014-8-8 3 4 5 6 肖展伟 肖展伟 肖展伟 宫迎宾 2014-8-7 2014-8-7 2014-8-7 2014-8-8 亚信科技(中国)有限公司版权所有
文档中的全部内容属亚信科技(中国)有限公司所有, 未经允许,不可全部或部分发表、复制、使用于任何目的。
目录
1. 概述 ......................................................................................................................................................... 0 1.1. 1.2. 1.3. 1.4.
编制说明 .......................................................................................................................................... 0 适用范围 .......................................................................................................................................... 0 参考文档 .......................................................................................................................................... 0 术语解释 .......................................................................................................................................... 0
2. 命名规范 ................................................................................................................................................. 2 2.1. 2.2. 2.3. 2.4. 2.5. 2.6. 2.7.
包名 .................................................................................................................................................. 2 类名 .................................................................................................................................................. 2 方法名 .............................................................................................................................................. 3 常量名 .............................................................................................................................................. 4 变量名 .............................................................................................................................................. 4 参数名 .............................................................................................................................................. 5 局部变量名 ...................................................................................................................................... 5
3. 布局规范 ................................................................................................................................................. 6 3.1. 3.2. 3.3. 3.5. 3.6. 3.7. 3.8. 3.9.
缩进对齐 .......................................................................................................................................... 6 一行一个语句 .................................................................................................................................. 6 行长度 .............................................................................................................................................. 7 空行 .................................................................................................................................................. 7 空格 .................................................................................................................................................. 8 大括号 .............................................................................................................................................. 9 圆括号 ............................................................................................................................................ 10 布局补充 ......................................................................................................................................... 11
4. 注释规范 ............................................................................................................................................... 12 4.1. 4.2. 4.3. 4.4. 4.5. 4.6.
整体要求 ........................................................................................................................................ 12 块注释 ............................................................................................................................................ 13 单行注释 ........................................................................................................................................ 14 尾端注释 ........................................................................................................................................ 14 类的注释 ........................................................................................................................................ 15 方法注释 ........................................................................................................................................ 15
5. 语句规范 ............................................................................................................................................... 16 5.1. 5.2. 5.3. 5.4. 5.5. 5.6. 5.7.
简单语句 ........................................................................................................................................ 16 复合语句 ........................................................................................................................................ 16 返回语句 ........................................................................................................................................ 17 IF,IF-ELSE,IF ELSE-IF ELSE语句 ................................................................................................ 17 FOR语句 ......................................................................................................................................... 18 WHILE语句 ..................................................................................................................................... 19 DO-WHILE语句 ............................................................................................................................... 19
ii
5.8. SWITCH语句 ................................................................................................................................... 19 5.9. TRY-CATCH语句 ............................................................................................................................. 20 6. 日志规范 ............................................................................................................................................... 21 6.1. 日志记录规范 ................................................................................................................................ 21 7. 异常规范 ............................................................................................................................................... 22 7.1. 捕获的异常:不能忽视 ................................................................................................................ 22 8. 框架规范 ............................................................................................................................................... 23 8.1. APPFRAME框架 .......................................................................................................................... 23 9. 开发约定 ............................................................................................................................................... 24 9.1. 性能优化 ........................................................................................................................................ 24
iii
1. 概述
1.1. 编制说明
为了提升事业部编码工作的规范性,促进产品代码的可读性、可维护性,提升团队协作开发效率,降低各产品线、部门之间研发沟通成本,迫切需要统一的编码规范,用来指导和要求日常的研发工作,因此组织事业部下属各部门技术专家共同制定《移动客户事业部编码规范》。
本规范体系包括Java、C++、Html/CSS、JavaScript、数据库(Oracle)SQL语言以及执行与检查测量分册。
本册对事业部内Java语言的编码规范进行详细阐述。
1.2. 适用范围
亚信Java代码开发人员 亚信代码质量控制人员 亚信设计工程师 亚信测试工程师 亚信PSO
1.3. 参考文档
1. Java官方规范
2. 现有研发中心、区域编码规范 3. 《Google Java Style》
1.4. 术语解释
本文中使用到的专业术语解释如下: 序号 术语 1 驼峰式命名法 解释 驼峰式命名法是程序编写时的一套命名规则,当变量名和函式名称