tencent java 编码规范.doc

GL/YF 013-2007V1.0-L1 PAGE  PAGE 14 腾讯集团管理标准 GL/YF 013-2007V1.0-L1 Java编码规范 2007-09-11发布 2007-09-11实施 ——————————————————————————————————— 腾讯集团 发布 GL/YF 013-2007V1.0-L1 前 言 本标准系公司首次发布实施，主要针对公司所有软件产品源代码范围的Java编码风格，对Java文件的文件组织、代码风格、注释、命名、声明、异常、习惯等方面均作出规范，以保障公司项目代码的易维护性和编码安全性。 本标准由研发管理部、3G产品中心共同制定。 本标准主要起草人：Junjun(张莉珺)、Iron（邱会发） 本标准主要审核人：anwenfeng(冯文信)、 Paulinesong(宋虹漫)、Ericlin（林松）、Stevezheng(郑全战) 、Junehuang(黄俊)、Kevinxu(许冠严)、polo(陈广域)、leon（郭凯天） 本标准批准人：jeffxiong(熊明华) 、charles(陈一丹)、 tony（张志东）、ponyma（马化腾） 本标准首次发布日期：2007年9月11日 本标准发送部门：公司各部门 JAVA编码规范 1 目的 为形成公司统一的Java编码风格，以保障公司项目代码的易维护性和编码安全性，特制定本规范。 2 适用范围 本标准适用于腾讯集团（含分公司等各级分支机构）所有使用Java作为开发语言的软件产品。 本标准中“腾讯集团”是指腾讯控股有限公司、其附属公司、及为会计而综合入账的公司，包括但不限于腾讯控股有限公司、深圳市腾讯计算机系统有限公司、腾讯科技（深圳）有限公司、腾讯科技（北京）有限公司、深圳市世纪凯旋科技有限公司、时代朝阳科技（深圳）有限公司、腾讯数码（深圳）有限公司、深圳市财付通科技有限公司。 3 总体原则 所有使用Java作为开发语言的软件产品都须遵照本规范的内容进行编码。 4 文件组织 4.1 规则 4.1.1由于超过2000行的程序难以阅读，应该尽量避免出现超过2000行的程序； 4.1.2一个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。 4.2 组织顺序 4.2.1文件注释（参见6.1文件注释）； 4.2.2包和引入语句：在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句； 4.2.3类或接口注释（参见6.2类或接口注释）； 4.2.4类或接口的声明； 4.2.5类或接口的实现注释：如果有关类或接口的信息不适合作为“类或接口文档注释”，可以在类或接口的实现注释中给出； 4.2.6类的（静态）变量：首先是类的公共变量，随后是保护变量，再后是包一级别的变量（没有访问修饰符），最后是私有变量； 4.2.7实例变量：首先是公共级别的，随后是保护级别的，再后是包一级别的（没有访问修饰符），最后是私有级别的； 4.2.8构造方法； 4.2.9方法：方法应该按功能分组，而不应该按作用域或访问权限进行分组。 4.3 范例 直接查看以下文件可以找到编码套用的规则： （注：可以通过复制粘贴保存到硬盘） 5 代码风格 5.1 缩进 5.1.1程序块要采用缩进风格编写，缩进只使用TAB键，不能使用空格键（编辑器中请将TAB设置为4格）； 5.1.2方法体的开始、类的定义、以及if、for、do、while、switch、case语句中的代码都要采用缩进方式； 5.2 对齐 5.2.1程序块的分界符左大括号{ 和右大括号}都另起一行，应各独占一行并且位于同一列，同时与引用它们的语句左对齐； 5.2.2对齐只使用TAB键，不使用空格键； 5.2.3不允许把多个短语句写在一行中，即一行只写一条语句； 5.2.4 if、for、do、while、case、switch、default等语句自占一行。 5.3 换行 一行的长度超过80个字符需要换行，换行规则如下： 5.3.1在一个逗号后面断开； 5.3.2在一个操作符前面断开； 5.3.3长表达式要在低优先级操作符处划分新行； 5.3.4新行缩进2个TAB。 5.4 间隔 5.4.1类、方法及相对独立的程序块之间、变量说明之后必须加空行； 5.4.2关键字之后要留空格， 象if、for、while 等关键字之后应留一个空格再跟左括号（， 以突出关键字； 5.4.3方法名与其左括号（之间不要留空格, 以与关键字区别； 5.4.4二元操作符如 =、 +=