项目开发及编码规范VIP免费

项目开发规范文档修订历史记录日期版本说明作者2009-12-25初稿1.简介目的1、用于规范指导开发组进行开发2、便于成员间的沟通与交流。3、有助于项目质量和稳定。4、为后期维护提供支持2.项目开发流程项目开发过程归纳分为以下步骤：1.建立SVN项目版本控制。包括文档，源码，Lib包等。2.了解需求，并对需求文档的书写。(见文档结构规则附录)。3.详细设计文档。(见文档结构规则附录)。功能模块设计，重要模块的算法设计。数据库设计等。根据需求定义开发平台及环境。4.编码。搭建开发平台，配置开发环境。编码。单元测试案例。5.书写软件安装手册文件，数据库脚本文件，以及注意事项(releasenotes)。6.交互测试组测试。根据测试组测试结果是否回归第4步（测试回归最好不要超过2次）。7.测试通过，交付上线使用。维护手册使用手册3.代码规范Java代码规范3.1.1Java类名类名可由：英文字母，数字，下划线组成。（数字，下划线不能够开头）类名由一个或者多个单词组成。单词通常要求简洁明了达意。能够通过类名能够大致了解此类的作用和用途。类名要求首字母大写，多个单词组成类名时，单词的首字母要求大写。建议：类名不要过于简单或者太长。可以对单词采用简化的名称：入：Number简化为：num。3.1.2Java类结构类仅作为数据结构，没有行为，他封装了一组或者相似的一些行为方法。所以一个类尽量功能单一，或者功能类似共有行为的。一个类不要过于庞大。通常情况下：一般逻辑类中应该有构造方法和main方法，main方法中应该有测试代码。每个类应该有toString()方法。3.1.2.1包和引入语句在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。报名的定义全部是小写字母。具体定义依据项目而定。引入包时候，同一类型的归纳到一块，用空行隔开。例如：import3.1.2类注释Java类开头应该有相应的注释：类版本描述，作者签名，日期时间，公司备注，类的功能作用相关描述等。（详细查看：注释）3.1.2.2类成员变量a)类变量要求放在类的开始声明。一行声明一个。b)变量名称首字母要求小写。其他命名规则类似与类名。c)static,final类型的变量，字母要求全部大写。d)尽量在声明局部变量的同时初始化。e)避免局部变量和成员变量同名，覆盖了成员变量。f)尽量变量私有化，缩小变量的作用域。3.1.2.3类成员方法a)方法名命名规则类似于成员变量命名规则。b)成员方法尽量私有化。d)方法与方法之间空一行分割，提高可读性。c)方法尽可能有注释：（详细查看：注释）e)方法尽可能尽早返回，结束。3.1.3Java语句3.1.3.1缩进排版a)4个空格(一个Tab建)常被作为缩进排版的一个单位。子模块应该和父模块保持一个缩进单位。b)尽量避免一行的长度超过80个字符.c)换行：当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：-在一个逗号后面断开-在一个操作符前面断开-宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开-新的一行应该与上一行同一级别表达式的开头处对齐-如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。如：someMethod(longExpression1,longExpression2,longExpression3,longExpression4,longExpression5);var=someMethod1(longExpression1,someMethod2(longExpression2,longExpression3));3.1.3.2注释Java程序有两类注释：实现注释(implementationcomments)和文档注释(documentcomments)。实现注释是使用/*...*/和.*/界定。文档注释可以通过javadoc工具转换成HTML文件。实现注释用以描述实现的细节，流程，和难点的描述。良好的实现注释有助于自己和别人易于读懂代码。文档注释它可以被那些手头没有源码的开发人员了解接口功能等。频繁的注释有时反映出代码的低质量。当你觉得被迫要加注释的时候，考虑一下是否可以重新设计该模块的代码结构或者逻辑，使其更清晰，而避免使用注释提醒该模块的实现，这样往往都能够提高代码质量。注释应被用来给出代码的总括，良好的代码里应该有大量的注释。当然也要避免代码已经提供清晰明了，显而易见注释。注释的格式：程序可以有4种实现注释的风格：块、单行、尾端和行末。...