软件团队的开发与合作规范PPT资料.pptx

软件团队的开发与合作规范PPT资料.pptx

《软件团队的开发与合作规范PPT资料.pptx》由会员分享，可在线阅读，更多相关《软件团队的开发与合作规范PPT资料.pptx（21页珍藏版）》请在冰豆网上搜索。

关于代码规范标准可参阅：

nnJavaProgrammingStyleGuideJavaProgrammingStyleGuidehttp:

/nAmbySoftInc.CodingStandardsforJavav17.01dAmbySoftInc.CodingStandardsforJavav17.01dhttp:

/nCodeConventionsfortheJavaTMProgrammingCodeConventionsfortheJavaTMProgrammingLanguageLanguagehttp:

/nn开发组长：

控制团队开发，只有在开发组长的授权下，才可进行基础开发组长：

控制团队开发，只有在开发组长的授权下，才可进行基础开发包的变动。

开发包的变动。

nn设计人员：

负责详细设计。

可控制的文档：

各种形式的设计文件设计人员：

各种形式的设计文件,包包括用例图，流程图等。

括用例图，流程图等。

nn编程人员：

负责程序开发。

程序源代码。

编程人员：

nn整合人员：

负责应用程序内部模块与模块之间的整合，以及应用程序整合人员：

负责应用程序内部模块与模块之间的整合，以及应用程序与应用平台之间的整合。

程序开发包，系统配置文件。

与应用平台之间的整合。

nn部署人员：

负责应用程序的部署，同时负责应用服务器的维护。

可控部署人员：

部署描述文件。

制的文档：

nn数据库管理员：

负责数据库的维护，调优。

数据库脚数据库管理员：

数据库脚本。

本。

nn测试人员：

负责程序的测试工作，可控制的文档：

测试报告。

测试人员：

nn在开发过程中，每个人可同时兼任数个角色，并进行角色转换。

在开发过程中，每个人可同时兼任数个角色，并进行角色转换。

开发环境应用程序服务器：

IBMWebSphereApplicationServer6.1数据库：

DB29.0开发工具：

JAVAIDEEclipse页面开发Editplus*、DreamWeaver*版本控制工具：

VSS软件环境搭建过程nn第1步：

安装DB2；

nn第2步：

安装WebSphere；

nn第3步：

安装ResourceOne；

nn第4步：

安装VSS；

nn第5步：

从VSS中下载应用程序的开发包，包括目录结构、基类，第三方开发包；

nn第6步：

将应用程序开发包部署进WebSphere；

Java程序命名规范nn包名：

包名：

PackagePackage的名字应该都是由小写单词组成。

如的名字应该都是由小写单词组成。

如test.demo.exampletest.demo.example。

nn文件名文件名：

文件名由英文单词组成，每个单词的首字母大写，不文件名由英文单词组成，每个单词的首字母大写，不要超过要超过44个单词，如个单词，如ShipOrder.javaShipOrder.java。

JavaJava文件的文件名要与程序中的文件的文件名要与程序中的publicpublic类名相同。

类名相同。

ServetServet文件要以文件要以ServletServlet做为结尾，如做为结尾，如AddCompanyServlet.javaAddCompanyServlet.java访问数据库的访问数据库的BeanBean要以要以DBBeanDBBean为结尾，如为结尾，如AddCompanyDBBean.javaAddCompanyDBBean.javaJava程序命名规范nn类名类名：

ClassClass的名字必须由大写字母开头而其他字母都小写的单词组成的名字必须由大写字母开头而其他字母都小写的单词组成nn变量名：

变量名：

ClassClass变量的命名变量的命名：

变量的名字必须用一个小写字母开头。

后面的单词：

后面的单词用大写字母开头。

用大写字母开头。

StaticFinalStaticFinal变量的命名变量的命名：

StaticFinalStaticFinal变量的名字应该都大写，并且变量的名字应该都大写，并且指出完整含义。

指出完整含义。

用有意义的名字命名变量用有意义的名字命名变量。

首先，用完整的英语单词或约定俗成的简写。

首先，用完整的英语单词或约定俗成的简写命名你的变量命名你的变量（不允许用汉语拼音不允许用汉语拼音），如：

，如：

firstNamefirstName，zipCodezipCode用复数命名用复数命名collectioncollection类变量类变量。

ollectionollection包括数组，包括数组，vectorvector等。

命名时等。

命名时使用复数：

使用复数：

customerscustomers，classmatesclassmatesnn方法名：

方法名：

方法的名字必须用一个小写字母开头。

方法的名字要与该方法的用途相关。

Java程序命名规范nn参数名：

参数的命名参数的命名：

参数的名字必须和变量的命名规：

参数的名字必须和变量的命名规范一致。

范一致。

方法的参数方法的参数：

使用有意义的参数命名，如果可使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字。

能的话，使用和要赋值的字段一样的名字。

Java程序命名规范nn增删改程序和页面的调用关系和文件名Java程序命名规范nn增删改程序和页面的调用关系和文件名增删改程序和页面的调用关系和文件名AddOrderServer,SaveOrderServer,AddOrderServer,SaveOrderServer,DeleteOrderServletDeleteOrderServlet不需要页面，其他有不需要页面，其他有JSPJSP页面的页面的ServletServlet要与要与JSPJSP文件名相对应。

文件名相对应。

OrderDetailServetOrderDetailServet对应两个对应两个JSPJSP文件，文件，EditOrderEditOrder用于可编辑状态，用于可编辑状态，ShowOrderShowOrder用于不可编辑状态。

用于不可编辑状态。

AddOrderServletAddOrderServlet和和SaveOrderServletSaveOrderServlet的返回页面的返回页面可以是可以是ListList页面，也可以是页面，也可以是DetailDetail页面，如果当前人已页面，如果当前人已完成所有可进行的操作，则回到完成所有可进行的操作，则回到ListList页面，如果未完成，页面，如果未完成，则回到则回到DetailDetail页面。

页面。

Java程序代码格式nn文件头文件头文件头文件头：

版权信息版权信息版权信息必须在java文件的开头，比如：

/*类名*日期*修改记录*CopyrightICSS2003*Allrightreserved.*/其他不需要出现在javadoc的信息也可以包含在这里。

Package/Importspackage行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。

如果import行中包含了同一个包中的不同子目录，则应该用*来处理。

对于import语句，如果某一个包中引用的类不超过三个（包括三个），不允许用importxxx.*;

格式。

将import的classes归类，按顺序罗列：

a.Java标准类（java.*）b.Java扩充类（javax.*）c.第三方类d.你的应用程序的类Java程序代码格式n缩进缩进缩进应该是每行4个空格，不要在源文件中保存Tab字符。

在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。

nn注释注释注释注释为保证开发后JAVADOC的顺利生成，开发人员必须在所有方法，全局变量前加入加上标准JAVA注释。

类注释需要包含以下要素：

方法描述参数：

param参数名说明返回值：

return说明例外情况：

exception完整类名说明/*thisisadocsample*paramargsarrayofstringarguments*returnNoreturnvalue*exceptionexceptionNoexceptionsthrown*/n页宽页宽页宽应该设置为80字符，源代码一般不会超过这个宽度，并导致无法完整显示，但这一设置也可以灵活调整。

在任何情况下，超长的语句应该在一个逗号或者一个操作符后折行，一条语句折行后，应该比原来的语句再缩进2个字符。

HTML/JSP代码规范nn文件头文件头文件头文件头文件头要写明该文件的用途，及修改记录。

如：

文件头要写明该文件的用途，及修改记录。

!

文件名：

OrderList.jspOrderList.jsp说明：

订单列表说明：

订单列表修改记录：

修改记录：

2003-08-242003-08-24，张三，增加一个按钮，张三，增加一个按钮nn缩进缩进缩进缩进HTMLHTML标记层次之间的缩进为标记层次之间的缩进为22个字符，个字符，JavaJava代码的缩进为代码的缩进为44个个字符，文件中不要有字符，文件中不要有TabTab符号，都要替换为空格。

符号，都要替换为空格。

Java编程技巧nnexit（）exit（）exitexit除了在除了在mainmain中可以被调用外，其他中可以被调用外，其他的地方不应该调用。

因为这样做不给任何代码的地方不应该调用。

因为这样做不给任何代码代码机会来截获退出。

一个类似后台服务地程代码机会来截获退出。

一个类似后台服务地程序不应该因为某一个库模块决定了要退出就退序不应该因为某一个库模块决定了要退出就退出。

出。

nn异常异常异常异常申明的错误应该抛出一个申明的错误应该抛出一个RuntimeExceptionRuntimeException或者派生的异常。

或者派生的异常。

顶层的顶层的mainmain（）（）函数应该截获所有的异常，并且打印（或者记函数应该截获所有的异常，并且打印（或者记录在日志中）在屏幕上。

录在日志中）在屏幕上。

Java编程技巧nn垃圾收集垃圾收集垃圾收集垃圾收集JAVAJAVA使用成熟的后台垃圾收集技术来代替引用计数。

但是这样会导致一个使用成熟的后台垃圾收集技术来代