软件团队的开发与合作规范ppt课件

1、软件工程开发规范.培训目的 开发规范培训的目的是为了保证在系统设计、编码、测试、维护的过程中工程组人员遵照一套一致系统设计规范、运用程序编写规范、页面风格规范，借以提高软件开发团队的效率、添加代码的一致性、可读性，可维护性，保证工程开发稳定。 本次培训提供了工程开发的各项规范以及指点原那么。开发人员在开发过程中必需严厉遵守此开发规范。 .开发规范参考资料想要更深化了解本次培训涉及到背景知识，可访问以下网站。SUN的官方网站：java.sun IBM官方网站：www-900.ibm/developerWorks关于代码规范规范可参阅：Java Programming Style Guide ja

2、varanch/style.jspAmbySoft Inc. Coding Standards for Java v17.01d ambysoft/javaCodingStandards.htmlCode Conventions for the JavaTM Programming Language java.sun/docs/codeconv/html/CodeConvTOC.doc.html.开发人员角色 开发组长：控制团队开发，只需在开发组长的授权下，才可进展根底开发包的变动。设计人员：担任详细设计。可控制的文档：各种方式的设计文件, 包括用例图，流程图等。编程人员：担任程序开发。可控制

3、的文档：程序源代码。整合人员：担任运用程序内部模块与模块之间的整合，以及运用程序与运用平台之间的整合。可控制的文档：程序开发包，系统配置文件。部署人员：担任运用程序的部署，同时担任运用效力器的维护。可控制的文档：部署描画文件。数据库管理员：担任数据库的维护，调优。可控制的文档：数据库脚本。测试人员：担任程序的测试任务，可控制的文档：测试报告。在开发过程中，每个人可同时兼任数个角色，并进展角色转换。 .开发环境 应用程序服务器：IBM WebSphere Application Server 6.1数据库：DB2 9.0开发工具：JAVA IDEEclipse 页面开发Editplus*、Dre

4、amWeaver*版本控制工具：VSS.软件环境搭建过程第1步：安装DB2； 第2步：安装WebSphere；第3步：安装ResourceOne； 第4步：安装VSS；第5步：从VSS中下载运用程序的开发包，包括目录构造、基类，第三方开发包；第6步：将运用程序开发包部署进WebSphere ； .Java程序 命名规范包名：Package 的名字应该都是由小写单词组成。如test.demo.example 。文件名 ：文件名由英文单词组成，每个单词的首字母大写，不要超越4个单词，如ShipOrder.java。Java文件的文件名要与程序中的public类名一样。Servet文件要以Servl

5、et做为结尾，如AddCompanyServlet.java访问数据库的Bean要以DBBean为结尾，如AddCompanyDBBean.java .Java程序 命名规范类名 ：Class 的名字必需由大写字母开头而其他字母都小写的单词组成变量名：Class 变量的命名 ：变量的名字必需用一个小写字母开头。后面的单词用大写字母开头。 Static Final 变量的命名 ：Static Final 变量的名字应该都大写，并且指出完好含义。用有意义的名字命名变量 。首先，用完好的英语单词或商定俗成的简写命名他的变量(不允许用汉语拼音)，如： firstName，zipCode用复数命名col

6、lection类变量。ollection包括数组，vector等。命名时运用复数： customers ，classmates方法名：方法的名字必需用一个小写字母开头。后面的单词用大写字母开头。方法的名字要与该方法的用途相关。 .Java程序 命名规范参数名 ：参数的命名 ：参数的名字必需和变量的命名规范一致。 方法的参数 ：运用有意义的参数命名，假设能够的话，运用和要赋值的字段一样的名字。.Java程序 命名规范增删改程序和页面的调用关系和文件名 .Java程序 命名规范增删改程序和页面的调用关系和文件名 AddOrderServer, SaveOrderServer, DeleteOrde

7、rServlet不需求页面，其他有JSP页面的Servlet要与JSP文件名相对应。OrderDetailServet对应两个JSP文件，EditOrder用于可编辑形状，ShowOrder用于不可编辑形状。AddOrderServlet和SaveOrderServlet的前往页面可以是List页面，也可以是Detail页面，假设当前人已完成一切可进展的操作，那么回到List页面，假设未完成，那么回到Detail页面。 .Java程序 代码格式文件头 ：版权信息 版权信息必需在 java 文件的开头，比如：/* 类名* 日期* 修正记录* Copyright ICSS 2003* All ri

8、ght reserved.*/其他不需求出如今 javadoc 的信息也可以包含在这里。Package/Imports package 行要在 import 行之前，import 中规范的包名要在本地的包名之前，而且按照字母顺序陈列。假设 import 行中包含了同一个包中的不同子目录，那么应该用 * 来处置。对于import语句，假设某一个包中援用的类不超越三个包括三个，不允许用import xxx.*;格式。将import的classes归类，按顺序罗列： a. Java规范类(java.*) b. Java扩展类(javax.*) c. 第三方类 d. 他的运用程序的类.Java程序 代

9、码格式缩进 缩进应该是每行4个空格，不要在源文件中保管Tab字符。 在运用不同的源代码管理工具时Tab字符将由于用户设置的不同而扩展为不同的宽度。注释 为保证开发后JAVA DOC的顺利生成，开发人员必需在一切方法，全局变量前参与加上规范JAVA注释。类注释需求包含以下要素：方法描画参数： param 参数名 阐明前往值： return 阐明例外情况：exception 完好类名 阐明/* this is a doc sample* param args array of string arguments* return No return value* exception exception

10、 No exceptions thrown */页宽 页宽应该设置为80字符， 源代码普通不会超越这个宽度， 并导致无法完好显示， 但这一设置也可以灵敏调整。 在任何情况下， 超长的语句应该在一个逗号或者一个操作符后折行， 一条语句折行后， 应该比原来的语句再缩进2个字符。.HTML/JSP 代码规范文件头文件头要写明该文件的用途，及修正记录。如：! 文件名：OrderList.jsp 阐明：订单列表 修正记录：2003-08-24，张三，添加一个按钮缩进 HTML标志层次之间的缩进为2个字符，Java代码的缩进为4个字符，文件中不要有Tab符号，都要交换为空格。 .Java编程技巧 exit

11、() exit 除了在 main 中可以被调用外，其他的地方不应该调用。由于这样做不给任何代码代码时机来截获退出。一个类似后台效力地程序不应该由于某一个库模块决议了要退出就退出。 异常 声明的错误应该抛出一个RuntimeException或者派生的异常。 顶层的main()函数应该截获一切的异常，并且打印或者记录在日志中在屏幕上。 .Java编程技巧渣滓搜集 JAVA运用成熟的后台渣滓搜集技术来替代援用计数。但是这样会导致一个问题：他必需在运用完对象的实例以后进展清场任务。比如一个prel的程序员能够这么写： .FileOutputStream fos = new FileOutputStr

12、eam(projectFile);project.save(fos, IDE Project File); . 除非输出流一出作用域就封锁，非援用计数的程序文语，比如JAVA，是不能自动完成变量的清场任务的。必需象下面一样写： FileOutputStream fos = new FileOutputStream(projectFile);project.save(fos, IDE Project File); fos.close();.Java编程技巧Clone 下面是一种有用的方法： implements CloneablepublicObject clone()try ThisClass

13、 obj = (ThisClass)super.clone();obj.field1 = (int)field1.clone();obj.field2 = field2;return obj; catch(CloneNotSupportedException e) throw new InternalError(Unexpected CloneNotSUpportedException: + e.getMessage();.Java编程技巧运用 StringBuffer 对象 在处置 String 的时候要尽量运用 StringBuffer 类，StringBuffer 类是构成 String

14、 类的根底。String 类将 StringBuffer 类封装了起来，以破费更多时间为代价为开发人员提供了一个平安的接口。当我们在构造字符串的时候，我们应该用 StringBuffer 来实现大部分的任务，当任务完成后将 StringBuffer 对象再转换为需求的 String 对象。比如：假设有一个字符串必需不断地在其后添加许多字符来完成构造，那么我们应该运用 StringBuffer 对象和她的 append() 方法。假设我们用 String 对象替代 StringBuffer 对象的话，会破费许多不用要的创建和释放对象的 CPU 时间。 防止太多的运用 synchronized 关

15、键字 防止不用要的运用关键字 synchronized，应该在必要的时候再运用她，这是一个防止死锁的好方法。 换行 假设需求换行的话，尽量用 println 来替代在字符串中运用n。 他不要这样： System.out.print(Hello,world!n); 要这样： System.out.println(Hello,world!); 或者他构造一个带换行符的字符串，至少要象这样： String newline = System.getProperty(line.separator); System.out.println(Hello world + newline); .数据库规范 数据库设计时，应按照关系数据库的建模理念，满足设计范式。在构造物理实体时，应参照DB2性能手册，优化DB2性能。 第一种规范方式：表中的每一行和每一列均有一个值，永远不会是一组值。 第二种规范方式：不在关键字中的每一列提供取决于整个关键字的现实。 第三种规范方式：每个非关键字列提供与其他非关键字列无关并只取决于该关键字的现实。 第四种规范方式：没有行包含有关一个实体的两个或更多个独立的多值现实。 每种范式均运用于特定条件。 .LOG记录规范级别(Level)：输出日志的重要程度，便于控制日志输出的多少。输出目的地(Appender)：日志可以被写入的存储空间，常见的有控制台、文件