软件开发规范v1.0.docx

我想忘记你，可做不到…… 
其实你并不是完美得无可替代， 
你永远是不懂我的心思 
不知道我为什么会因为一件小事 
就能开心一整天 
也不知道我为什么会因为一句话 
而难过好多天 
不懂我的任性 
我的乱发脾气 
我的恨从成一套，很少统一，导致理解困难，影响团队的开发效率及系统的质量等。因此，一份完整并被严格执行的开发规范是非常必须的，特别是对软件公司的开发团队而言。
最根本的原则：
代码虽然是给机器运行的，但却是给人读的！
命名规范(Naming Conventions)
命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。大家遵守一定的规范，相互看其他人的代码也会更加方便。
使用可以准确说明变量/字段/类/接口/包等的完整的英文描述符。例如，采用类似firstName，listAllUsers 或CorporateCustomer 这样的名字，尽量不使用汉语拼音及不相关单词命名，严禁使用汉语拼音首字母组合命名，虽然Java 支持Unicode
Page 7 of 53
命名，但本规范规定对包、类、接口、方法、变量、字段等不得使用汉字等进行命名。
采用该领域的术语。如果用户称他们的“客户” (clients) 为“顾客”(customers)，那么就采用术语Customer 来命名这个类，而不用Client。
采用大小写混合，提高名字的可读性。一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写。包名全部小写。
避免使用长名字（最好不超过25 个字母）。
避免使用相似或者仅在大小写上有区别的名字。
避免使用数字，但可用2 代替to，用4 代替for 等，如：go2Jsp。
包命名
包名一般以项目或模块名命名，少用缩写和长名，一律小写，正则表达式为：^[a-z]+(\.[a-zA-Z_][a-zA-Z0-9_]*)*$。
包名按如下规则组成：[基本包].[项目名].[模块名].[子模块名]..
OA项目的包命名前三级为：。
不得将类直接定义在基本包下，所有项目中的类、接口等都当定义在各自的项目和模块包中。
类命名
类名采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML)。一般采用名词。
Page 9 of 53
接口命名
大小写规则与类名相似。接口可带I 前缀或able、ible、er 等后缀。
方法命名
方法名是一个动名结构，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。正则表达式为：^[a-z][a-zA-Z0-9]*$
类中常用方法的命名：
类的获取方法（一般具有返回值）一般要求在被访问的字段名前加上get，如
getFirstName()，getLastName()。
类的设置方法（一般返回类型为void）：被访问字段名的前面加上前缀 set，如
setFirstName(),setLastName().
类的布尔型的判断方法一般要求方法名使用单词 is 做前缀，如isPersistent()isString()。或者使用具有逻辑意义的单词，例如equal 或equals。
类的普通方法一般采用完整的英文描述说明成员方法功能，第一个单词尽可能采用动词，首字母小写，如openFile（），addCount（）。
构造方法应该用递增的方式写。（参数多的写在后面）。
toString()方法：一般情况下，每个类都应该定义toString(),其格式为：
public String toString(){…}。
类成员 参数
和类命名一样，但是首字母小写。参数命名和类成员命名一致。'^[a-z][a-zA-Z0-9]*$'
Page 9 of 53
局部变量
局部变量名不应以下划线或美元符号开头，这个是java命名的惯例。局部变量建议全部使用小写。除了局部变量名外，所有实例，包括类，类常量，均采用大小写混合的方式。
变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量（往往用在for循环中），临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。正则表达式为：^[a-z][a-z0-9]*$
常量
类常量和ANSI常量(static , final 字段)的声明，应该全部大写，单词间用下划线隔开