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

System.out.println("Hello world" + newline);
数据库规范
数据库设计时，应依照关系数据库的建模理 念，满足设计范式。在构造物理实体时，应参照 DB2性能手册，优化DB2性能。
第一种规范形式：表中的每一行和每一列均 有一个值，永远不会是一组值。
第二种规范形式：不在关键字中的每一列提 供取决于整个关键字的事实。
文件名：OrderList.jsp 说明：订单列表 修改记录：2003-08-24，张三，增加一个按钮
缩进
HTML标记层次之间的缩进为2个字符，Java代码的缩进为4个 字符，文件中不要有Tab符号，都要替换为空格。
Java编程技巧
exit() exit 除了在 main 中可以被调用外，其他
包括目录结构、基类，第三方开发包； 第6步：将应用程序开发包部署进
WebSphere ；
Java程序 命名规范
包名：
Package 的名字应该都是由小写单词组成。如 test.demo.example 。
文件名 ：
文件名由英文单词组成，每个单词的首字母大写，不 要超过4个单词，如ShipOrder.java。
参数： @param 参数名 说明
返回值： @return 说明
例外情况：@exception 完整类名 说明
/** this is a doc sample
* @param args array of string arguments
* @return No return value
* @exception exception No exceptions thrown
第三种规范形式：每个非关键字列提供与其 他非关键字列无关并只取决于该关键字的事实。
第四种规范形式：没有行包含有关一个实体 的两个或更多个独立的多值事实。
每种范式均应用于特定条件。
LOG记录规范
级别(Level)：输出日志的重要程度，便于 控制日志输出的多少。
输出目的地(Appender)：日志可以被写入 的存储空间，常见的有控制台、文件、数 据库、NT日志库、Syslog、远程文件服务 器等等。
间为代价）为开发人员提供了一个安全的接口。当我们在构造字符串的时候，
我们应该用 StringBuffer 来实现大部分的工作，当工作完成后将
StringBuffer 对象再转换为需要的 String 对象。比如：如果有一个字符串必
须不断地在其后添加许多字符来完成构造，那么我们应该使用 StringBuffer
的地方不应该调用。因为这样做不给任何代码 代码机会来截获退出。一个类似后台服务地程 序不应该因为某一个库模块决定了要退出就退 出。 异常
申明的错误应该抛出一个 RuntimeException或者派生的异常。 顶层的 main()函数应该截获所有的异常，并且打印（ 或者记录在日志中）在屏幕上。
Java编程技巧
CloneNotSUpportedException: " + e.getMessage()); } }
Java编程技巧
使用 StringBuffer 对象
在处理 String 的时候要尽量使用 StringBuffer 类，StringBuffer 类是构成
String 类的基础。String 类将 StringBuffer 类封装了起来，（以花费更多时
ቤተ መጻሕፍቲ ባይዱ
换行
如果需要换行的话，尽量用 println 来代替在字符串中使用"\n"。
你不要这样： System.out.print("Hello,world!\n");
要这样： System.out.println("Hello,world!");
或者你构造一个带换行符的字符串，至少要象这样：
String newline = System.getProperty("line.separator");
变量名：
Class 变量的命名 ：变量的名字必须用一个小写字母开头。后面的单词 用大写字母开头。
Static Final 变量的命名 ：Static Final 变量的名字应该都大写，并且 指出完整含义。
用有意义的名字命名变量 。首先，用完整的英语单词或约定俗成的简写 命名你的变量(不允许用汉语拼音)，如： firstName，zipCode
*/
页宽
页宽应该设置为80字符， 源代码一般不会超过这个宽度， 并导致无法完整显示， 但这一 设置也可以灵活调整。 在任何情况下， 超长的语句应该在一个逗号或者一个操作符后折行， 一条语句折行后， 应该比原来的语句再缩进2个字符。
HTML/JSP 代码规范
文件头
文件头要写明该文件的用途，及修改记录。如： <!—
垃圾收集 JAVA使用成熟的后台垃圾收集技术来代替引用计数。但是这样会导致一个 问题：你必须在使用完对象的实例以后进行清场工作。比如一个prel的程 序员可能这么写：
... { FileOutputStream fos = new FileOutputStream(projectFile); project.save(fos, "IDE Project File"); } ...
Java文件的文件名要与程序中的public类名相同。 Servet文件要以Servlet做为结尾，如
AddCompanyServlet.java 访问数据库的Bean要以DBBean为结尾，如
AddCompanyDBBean.java
Java程序 命名规范
类名 ：
Class 的名字必须由大写字母开头而其他字母都小写的单词组成
http://www.javaranch.com/style.jsp
AmbySoft Inc. Coding Standards for Java v17.01d
http://www.ambysoft.com/javaCodingStandards.html
Code Conventions for the JavaTM Programming
方法的参数 ：使用有意义的参数命名，如果可 能的话，使用和要赋值的字段一样的名字。
Java程序 命名规范
增删改程序和页面的调用关系和文件名
Java程序 命名规范
增删改程序和页面的调用关系和文件名
AddOrderServer, SaveOrderServer, DeleteOrderServlet不需要页面，其他有JSP页面的 Servlet要与JSP文件名相对应。OrderDetailServet 对应两个JSP文件，EditOrder用于可编辑状态， ShowOrder用于不可编辑状态。
除非输出流一出作用域就关闭，非引用计数的程序语言，比如JAVA，是不 能自动完成变量的清场工作的。必须象下面一样写：
FileOutputStream fos = new FileOutputStream(projectFile); project.save(fos, "IDE Project File"); fos.close();
Language
http://java.sun.com/docs/codeconv/html/CodeConvTOC.do
c.html
开发人员角色
开发组长：控制团队开发，只有在开发组长的授权下，才可进行基础 开发包的变动。
设计人员：负责详细设计。可控制的文档：各种形式的设计文件, 包 括用例图，流程图等。
编程人员：负责程序开发。可控制的文档：程序源代码。 整合人员：负责应用程序内部模块与模块之间的整合，以及应用程序
与应用平台之间的整合。可控制的文档：程序开发包，系统配置文件 。 部署人员：负责应用程序的部署，同时负责应用服务器的维护。可控 制的文档：部署描述文件。 数据库管理员：负责数据库的维护，调优。可控制的文档：数据库脚 本。 测试人员：负责程序的测试工作，可控制的文档：测试报告。 在开发过程中，每个人可同时兼任数个角色，并进行角色转换。
Java程序 代码格式
缩进
缩进应该是每行4个空格，不要在源文件中保存Tab字符。 在使用不同的源代码管理工具 时Tab字符将因为用户设置的不同而扩展为不同的宽度。
注释
为保证开发后JAVA DOC的顺利生成，开发人员必须在所有方法，全局变量前加入加上标准 JAVA注释。
类注释需要包含以下要素：
方法描述
用复数命名collection类变量。ollection包括数组，vector等。命名时 使用复数： customers ，classmates
方法名：
方法的名字必须用一个小写字母开头。后面的单词用大写字母开头。 方法的名字要与该方法的用途相关。
Java程序 命名规范
参数名 ：
参数的命名 ：参数的名字必须和变量的命名规 范一致。
开发规范参考资料
想要更深入了解本次培训涉及到背景知识，可访问以下网站。
SUN的官方网站：http://java.sun.com
IBM官方网站：http://www-900.ibm.com/developerWorks
关于代码规范标准可参阅：
Java Programming Style Guide
Package/Imports package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列
。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。对于import语句，如 果某一个包中引用的类不超过三个（包括三个），不允许用import xxx.*;格式。 将import的classes归类，按顺序罗列： a. Java标准类(java.*) b. Java扩充类(javax.*) c. 第三方类 d. 你的应用程序的类
软件项目开发规范
培训目的
开发规范培训的目的是为了保证在系统设计 、编码、测试、维护的过程中项目组人员遵循一 套统一系统设计标准、应用程序编写标准、页面 风格标准，借以提高软件开发团队的效率、增加 代码的统一性、可读性，可维护性，保障项目开 发稳定。
本次培训提供了项目开发的各项规范以及指 导原则。开发人员在开发过程中必须严格遵守此 开发规范。
AddOrderServlet和SaveOrderServlet的返回页面 可以是List页面，也可以是Detail页面，如果当前人已 完成所有可进行的操作，则回到List页面，如果未完成 ，则回到Detail页面。
Java程序 代码格式
文件头 ：
版权信息 版权信息必须在 java 文件的开头，比如： /** * 类名 * * 日期 * 修改记录 * Copyright ICSS 2003 * All right reserved. */ 其他不需要出现在 javadoc 的信息也可以包含在这里。
对象和她的 append() 方法。如果我们用 String 对象代替 StringBuffer 对
象的话，会花费许多不必要的创建和释放对象的 CPU 时间。
避免太多的使用 synchronized 关键字
避免不必要的使用关键字 synchronized，应该在必要的时候再使用她，这是一个避免死 锁的好方法。
Java编程技巧
Clone
下面是一种有用的方法： implements Cloneable public Object clone() { try { ThisClass obj = (ThisClass)super.clone(); obj.field1 = (int[])field1.clone(); obj.field2 = field2; return obj; } catch(CloneNotSupportedException e) { throw new InternalError("Unexpected
开发环境
应用程序服务器： 数据库： 开发工具：
JAVA IDE 页面开发 版本控制工具：
IBM WebSphere Application Server 6.1 DB2 9.0
Eclipse Editplus*、DreamWeaver* VSS
软件环境搭建过程
第1步：安装DB2； 第2步：安装WebSphere； 第3步：安装ResourceOne； 第4步：安装VSS； 第5步：从VSS中下载应用程序的开发包，