腾讯编码规范剖析.doc

腾讯集团管理标准 GL/YF 013-2007V1.0-L1 Java编码规范 2007-09-11发布 2007-09-11实施 ——————————————————————————————————— 腾讯集团 发布 前 言 本标准系公司首次发布实施，主要针对公司所有软件产品源代码范围的Java编码风格，对Java文件的文件组织、代码风格、注释、命名、声明、异常、习惯等方面均作出规范，以保障公司项目代码的易维护性和编码安全性。 本标准由研发管理部、3G产品中心共同制定。 本标准主要起草人：Junjun(张莉珺)、Iron（邱会发） 本标准主要审核人：anwenfeng(冯文信)、 Paulinesong(宋虹漫)、Ericlin（林松）、Stevezheng(郑全战) 、Junehuang(黄俊)、Kevinxu(许冠严)、polo(陈广域)、leon（郭凯天） 本标准批准人：jeffxiong(熊明华) 、charles(陈一丹)、 tony（张志东）、ponyma（马化腾） 本标准首次发布日期：2007年9月11日 本标准发送部门：公司各部门 JAVA编码规范 1 目的 为形成公司统一的Java编码风格，以保障公司项目代码的易维护性和编码安全性，特制定本规范。 2 适用范围 本适用于腾讯（含分公司等各级分支机构）所有。所有 4.1.1由于超过2000行的程序难以阅读，应该尽量避免个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。 4.2.1文件注释（参见6.1文件注释）； 4.2.2包和引入语句：在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句有关类或接口的信息不适合作为类接口文档注释（注：可以通过复制粘贴保存到硬盘） 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个字符在一个逗号后面断开在一个操作符前面断开缩进方法名与其左括号之间 for语句中的表达式应该被空格分开 5.4.8强制转型后应该跟一个空格 6 注释 原则： ——对已经不推荐使用的类和方法需要注明@Deprecated，并说明替代的类或者方法； ——对于针对集合、开关的方法，要在方法注释中表明是否多线程安全。 6.1 文件注释 所有的源文件都应该在开头有一个注释，其中列出版权声明、 6.2 类或接口注释 采用JavaDoc文档注释 注：JavaDoc文档注释描述Java的类、接口、构造方法方法以及字段。每个文档注释都会被置于注释定界符/**...*/之中，一个注释对应一个类、接口或成员。该注释应位于声明之前文档注释的第一行(/**)不需缩进随后的文档注释每行都缩进1格(使星号纵向对齐)。JavaDoc文档注释 6.4 方法注释 采用JavaDoc文档注释 6.5 其它注释(非JavaDoc文档注释注释界定符// 6.5.2多行注释使用注释界定符/*...*/ 7 命名 7.1 基本规则 7.1.1使用可以准确说明变量、字段、类、接口、包等完整的英文描述符； 7.1.2采用大小写混合，提高名字的可读性； 7.1.3采用该领域的术语；尽量少用缩写，但如果一定要使用，当使用公共缩写和习惯缩写等； 7.1.4避免使用相似或者仅在大小写上有区别的名字。 7.2 包命名 7.2.1包名一律小写, 少用缩写和长名； 7.2.2采用以下规则： [基本包].[项目名].[模块名].[子模块名]... 7.2.3基本包：com.tencent 或 com.qq； 7.2.4不得将类直接定义在基本包下，所有项目中的类、接口等都应当定义在各自的项目和模块包中； 例如： 7.3 类或接口命名 类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩