软件开发规范v1.0

《软件开发规范v1.0》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、开发规范文档版本<1.0>修订历史记录日期版本说明作者<2013-1-21><1.0>初稿linsm目录1.前言51.1目的51.2概述52.命名规范(NamingConventions)52.1包命名62.2类命名62.3接口命名62.4方法命名62.5类成员参数72.6局部变量72.7常量72.8集合72.9魔法数字72.10其他82.11项目分层83.代码排版规范93.1空行93.2空格93.3大括号(Braces)103.4换行(NewLines)103.5长度(Length)104.声明104.1类、接口104.2方法104.3字段115.其他约

2、束115.1类成员可见性115.2赋值(Assignment)115.3125.4条件表达式使用125.5无效语句125.6Import规范125.7String比较135.8注释要求135.9Tryif嵌套层次和分支复杂度145.10Switch语句146.设计规范156.1类与接口156.2方法156.3表达式与语句166.4控制语句166.5循环语句176.6异常处理18软件开发规范文档1.前言1.1目的本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高

3、程序的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。1.2概述对于代码，首要要求是它必须正确，能够按照设计预定功能去运行；第二是要求代码必须清晰易懂，使自己和其他的程序员能够很容易地理解代码所执行的功能等。然而，在实际开发中，每个程序员所写的代码却经常自成一套，很少统一，导致理解困难，影响团队的开发效率及系统的质量等。因此，一份完整并被严格执行的开发规范是非常必须的，特别是对软件公司的开发团队而言。最根本的原则：代码虽然是给机器运行的，但却是给人读的！2.命名规范(NamingConventions)命名规范使程序更

4、易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。大家遵守一定的规范，相互看其他人的代码也会更加方便。Ø使用可以准确说明变量/字段/类/接口/包等的完整的英文描述符。例如，采用类似firstName，listAllUsers或CorporateCustomer这样的名字，尽量不使用汉语拼音及不相关单词命名，严禁使用汉语拼音首字母组合命名，虽然Java支持Unicode命名，但本规范规定对包、类、接口、方法、变量、字段等不得使用汉字等进行命名。Ø采用该领域的术语。如果用户称他们的“客户”(cli

5、ents)为“顾客”(customers)，那么就采用术语Customer来命名这个类，而不用Client。Ø采用大小写混合，提高名字的可读性。一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写。包名全部小写。Ø避免使用长名字（最好不超过25个字母）。Ø避免使用相似或者仅在大小写上有区别的名字。Ø避免使用数字，但可用2代替to，用4代替for等，如：go2Jsp。1.1包命名包名一般以项目或模块名命名，少用缩写和长名，一律小写，正则表达式为：^[a-z]+(.[a-zA-Z_][a-zA-Z0-9_]*)*$。包名按如下规

6、则组成：[基本包].[项目名].[模块名].[子模块名]..OA项目的包命名前三级为：com.well.oa。不得将类直接定义在基本包下，所有项目中的类、接口等都当定义在各自的项目和模块包中。1.2类命名类名采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML)。一般采用名词。1.1接口命名大小写规则与类名相似。接口可带I前缀或able、ible、er等后缀。1.2方法命名方法名是一个动名结构，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。正则

7、表达式为：^[a-z][a-zA-Z0-9]*$类中常用方法的命名：1.类的获取方法（一般具有返回值）一般要求在被访问的字段名前加上get，如getFirstName()，getLastName()。2.类的设置方法（一般返回类型为void）：被访问字段名的前面加上前缀set，如setFirstName(),setLastName().3.类的布尔型的判断方法一般要求方法名使用单词is做前缀，如isPersistent()isString()。或者使用具有逻辑意义的单词，例如equal或equals。4.类的普通方法一般采用完整的英文描述说明成员方法功能，

8、第一个单词尽可能采用动词，首字母小写，如openFile（），ad