华为程序编写规范
1 排版
1.1：程序块要采用缩进风格编写，缩进的空格数为4个。对于由开发工具自动生成的代码可以有不一致。
1.2：相对独立的程序块之间、变量说明之后必须加空行。
1.3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
1.4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
1.5：若函数或过程中的参数较长，则要进行适当的划分。
1.6：不允许把多个短语句写在一行中，即一行只写一条语句。
1.7：if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
1.8：对齐只用空格键，不使用TAB键。
说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐，不要使用BC作为编辑器合版本，因为BC会自动将8个空格变为一个TAB键，因此使用BC合入的版本大多会将缩进变乱。
1.9：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。
1.10：程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
1.11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。
说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C++语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。
2 注释
2.1：一般情况下，源程序有效注释量必须在20％以上。
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
2.2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。
2.3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。
2.4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
2.5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
2.6：注释的内容要清楚、明了，含义准确，防止注释二义性。
说明：错误的注释不但无益反而有害。
2.7：避免在注释中使用缩写，特别是非常用缩写。
说明：在使用缩写时或之前，应对缩写进行必要的说明。
2.8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
2.9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
2.10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。
2.11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
2.12：注释与所描述内容进行同样的缩排。
说明：可使程序排版整齐，并方便注释的阅读与理解。
2.13：将注释与其上面的代码用空行隔开。
2.14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。
2.15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个c ase后进入下一个case处理，必须在该case语句处理完、下一个case语句前 加上明确的注释。
说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。
3 标识符命名
3.1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。
说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。
3.2：命名中若使用特殊约定或缩写，则要有注释说明。
说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。
3.3：自己特有的命名风格，要自始至终保持一致，不可来回变化。
说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即命名规则中没有规定到的地方才可有个人命名风格）。
3.4：对于变量命名，禁止取单个字符（如i、j、k…），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。
说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。
3.5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用作特殊标识如标识成员变量或全局变量的m_和g_，其后加上大小写混排的方式是允许的。
4 可读性
4.1：注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。
说明：防止阅读程序时产生误解，防止因默认的优先级与设计思想不符而导致程序出错。
4.2：避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。
5 变量、结构
5.1：去掉没必要的公共变量。
说明：公共变量是增大模块间耦合的原因之一，故应减少没必要的公共变量以降低模块间的耦合度。
5.2：仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。
说明：在对变量声明的同时，应对其含义、作用及取值范围进行注释说明，同时若有必要还应说明与其它变量的关系。
5.3：明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。
说明：明确过程操作变量的关系后，将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。
5.4：当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。
说明：对公共变量赋值时，若有必要应进行合法性检查，以提高代码的可靠性、稳定性。
5.5：防止局部变量与公共变量同名。
说明：若使用了较好的命名规则，那么此问题可自动消除。
5.6：严禁使用未经初始化的变量作为右值。
说明：特别是在C/C++中引用未经赋值的指针，经常会引起系统崩溃。
6 函数、过程
6.1：对所调用函数的错误返回码要仔细、全面地处理。
6.2：明确函数功能，精确（而不是近似）地实现函数设计。
6.3：编写可重入函数时，应注意局部变量的使用（如编写C/C++语言的可重入函数时，应使用auto即缺省态局部变量或寄存器变量）。
说明：编写C/C++语言的可重入函数时，不应使用static局部变量，否则必须经过特殊处理，才能使函数具有可重入性。
6.4：编写可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段对其加以保护。
说明：若对所使用的全局变量不加以保护，则此函数就不具有可重入性，即当多个进程调用此函数时，很有可能使有关全局变量变为不可知状态。
6.5：在同一项目组应明确规定对接口函数参数的合法性检查应由函数的调用者负责还是由接口函数本身负责，缺省是由函数调用者负责。
说明：对于模块间接口函数的参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患；要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。
6.1：防止将函数的参数作为工作变量。
说明：将函数的参数作为工作变量，有可能错误地改变参数内容，所以很危险。对必须改变的参数，最好先用局部变量代之，最后再将该局部变量的内容赋给该参数。
腾讯程序编写规范
一、java文件组织
文件组织规则：由于超过2000行的程序难以阅读，应该尽量避免出现超过2000行的程序。一个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。
文件组织顺序：
1.文件注释：所有的源文件都应该在开头有一个注释，其中列出文件的版权声明、文件名、功能描述以及创建、修改记录：
2.包和引入语句：在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟导包语句
3. 类或接口注释：采用JavaDoc文档注释，在类、接口定义之前应当对其进行注释，包括类、接口的描述、最新修改者、版本号、参考链接等；
注：JavaDoc文档注释：描述Java的类、接口、构造方法、方法、以及字段。每个文档注释都会被置于注释定界符/…*/之中，一个注释对应一个类、接口或成员。该注释应位于声明之前。文档注释的第一行(/**)不需缩进，随后的文档注释每行都缩进1格(使星号纵向对齐)。
4. 类或接口的声明**
5. 类或接口的实现注释：如果有关类或接口的信息不适合作为“类或接口文档注释”，可以在类或接口的实现注释中给出；
6. 类的（静态）变量：首先是类的公共变量，随后是保护变量，再后是包一级别的变量（没有访问修饰符），最后是私有变量；
7. 实例变量：首先是公共级别的，随后是保护级别的，再后是包一级别的（没有访问修饰符），最后是私有级别的；
8. 构造方法；
9. 普通方法：方法应该按功能分组，而不应该按作用域或访问权限进行分组。
二、代码风格
1.缩进：程序块要采用缩进风格编写，缩进只使用TAB键，不能使用空格键（编辑器中请将TAB设置为4格）；方法体的开始、类的定义、以及if、for、do、while、switch、case语句中的代码都要采用缩进方式；
2.对齐：程序块的分界符左大括号”{” 和右大括号”}”都另起一行，应各独占一行并且位于同一列，同时与引用它们的语句左对齐；对齐只使用TAB键，不使用空格键；不允许把多个短语句写在一行中，即一行只写一条语句；if、for、do、while、case、switch、default等语句自占一行。
3.换行：一行的长度超过80个字符需要换行，换行规则如下：
在一个逗号后面断开；
在一个操作符前面断开；
长表达式要在低优先级操作符处划分新行；
新行缩进2个TAB。
4.间隔：类、方法及相对独立的程序块之间、变量说明之后必须加空行；关键字之后要留空格， 象if、for、while 等关键字之后应留一个空格再跟左括号”（”， 以突出关键字；方法名与其左括号”（”之间不要留空格, 以与关键字区别；二元操作符如 ” =”、” +=” ” >=”、” <=”、” +”、” *”、” %”、” &&”、” ||”、” <<” ,” ^” 等的前后应当加空格；一元操作符如” !”、” ~”、” ++”、” –”等前后不加空格；xiang”［ ］”、” .” 这类操作符前后不加空格；for语句中的表达式应该被空格分开；强制转型后应该跟一个空格。
三、注释
1.原则：对已经不推荐使用的类和方法需要注明@Deprecated，并说明替代的类或者方法；对于针对集合、开关的方法，要在方法注释中表明是否多线程安全。
2．字段注释: 采用JavaDoc文档注释，定义为public的字段必需给出注释，在类的(静态)变量、实例变量定义之前当对其进行注释，给出该字段的描述等：
3.方法注释：采用JavaDoc文档注释，在方法定义之前当对其进行注释，包括方法的描述、输入、输出及返回值说明、抛出异常说明、参考链接等：
4.单行注释格式//
5.多行注释格式/……/
四、命名规则
1.基本规则:使用可以准确说明变量、字段、类、接口、包等完整的英文描述符；采用大小写混合，提高名字的可读性；采用该领域的术语；尽量少用缩写，但如果一定要使用，当使用公共缩写和习惯缩写等；避免使用相似或者仅在大小写上有区别的名字。
2.包命名：包名一律小写, 少用缩写和长名；采用以下规则：
[基本包].[项目名].[模块名].[子模块名]…
不得将类直接定义在基本包下，所有项目中的类、接口等都应当定义在各自的项目和模块包中。
3.类或接口命名：类或接口名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免用缩写词(除非该缩写词被更广泛使用，像URL，HTML)。
4.变量命名: 采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写；变量名不应以下划线或美元符号开头；尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型；不采用匈牙利命名法则，对不易清楚识别出该变量类型的变量应使用类型名或类型名缩写作其后缀；组件或部件变量使用其类型名或类型名缩写作其后缀；集合类型变量，例如数组和矢量，应采用复数命名或使用表示该集合的名词做后缀。
5.常量命名：全部采用大写，单词间用下划线隔开。
6．方法命名：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写；取值类可使用get前缀，设值类可使用set前缀，判断类可使用is(has)前缀。
五、声明
1.类或接口的声名：类、接口定义语法规范如下
[可见性][(‘abstract’|’final’)] [Class|Interface] class_name
[(‘extends’|’implements’)][父类或接口名]{
//方法体
}
2.方法声明：良好的程序设计应该尽可能减小类与类之间耦合，所遵循的经验法则是：尽量限制成员函数的可见性。如果成员函数没必要公有 (public)，就定义为保护 (protected)；没必要保护 (protected)，就定义为私有 (private)；方法定义语法规范：
[可见性][‘abstract’] [‘static’] [‘final’] [‘synchronized’][返回值类型] method_name(参数列表)[(‘throws’)][异常列表]{
//方法体
}
声明顺序：构造方法、静态公共方法、静态私有方法、公共方法、友元方法、受保护方法、私有方法、main方法；方法参数建议顺序：(被操作者，操作内容，操作标志，其他)。
3.变量声明：一行一个声明；声明局部变量的同时初始化（在变量的初始值依赖于某些先前发生的计算的特殊情况下可以不用同时初始化）；只在代码块的开始处声明变量，（一个块是指任何被包含在大括号”{“和”}”中间的代码）不要在首次用到该变量时才声明；避免声明的局部变量覆盖上一级声明的变量，即不要在内部代码块中声明相同的变量名；公共和保护的可见性应当尽量避免，所有的字段都建议置为私有，由获取和设置成员函数（Getter、Setter）访问；定义一个变量或者常量的时候，不要包含包名（类似java.security.MessageDigest digest = null），除非是两个包有相同的类名；数组声明时应当将”[]”跟在类型后，而不是字段名后；声明顺序：常量、类变量、实例变量、公有字段、受保护字段、友元字段、私有字段。
六、异常
1.捕捉异常的目的是为了处理它
2. 多个异常应分别捕捉并处理，避免使用一个单一的catch来处理。
七、习惯
1. if、for、do、while等语句的执行语句部分无论多少都要加括号”{}”
2. 每当一个case顺着往下执行时(因为没有break语句)，通常应在break语句的位置添加注释；
3. 尽量避免在循环中构造和释放对象
4. 在使用局部变量的过程，按就近原则处理。不允许定义一个局部变量，然后在很远的地方才使用；
5.相同的功能不允许复制成N份代码；
6. 在处理 String 的时候要尽量使用 StringBuffer 类。