科技信息化管理系统详细说明书.docx

科技信息化管理系统

详细设计说明书

编写：0502java第五组

日期：2012-5-31

王刘娣

日期：2012-5-31

日期：

受控状态：

是

发布版次：1.1

日期：2012-5-31

编号：

目录

TOC\o1-4\h\z\u

1引言5

1.1编写目的5

1.2背景5

1.3基线5

1.4定义5

2编码标准6

2.1命名标准6

2.2注释规那么6

2.3缩进排版7

3模块汇总7

3.1模块汇总表8

3.2模块关系图8

3.3包层次结构9

4子系统模块设计11

4.1功能模块11

4.1.1申请模块11

4.1.2审批模块25

工程管理模块40

4.1.4系统管理模块48

用户管理、角色权限管理48

公司管理55

部门管理58

文档管理61

4.2公共模块64

个人信息64

登录模块67

1引言

1.1编写目的

本说明书目的在于明确说明系统各功能的实现方式，指导开发员进行编码。

本说明书的预期读者为：代码开发员等。

1.2背景

待开发软件系统的名称：科技信息化管理系统

此软件系统任务提出者：中软国际公司

此软件系统任务开发者：中软国际-飞蚁队

此软件系统任务用户：中软国际公司员工

1.3基线

科技信息化管理系统需求规格说明书v1.6

1.4定义

为统一概念，防止混淆，本技术文档对客户端内容管理系统的根本概念和术语进行了分类和解释。

编号

术语

描述

01

系统管理员

可以登录本系统进行系统管理的用户

02

科技工程管理员

进行科技工程管理

03

待办工程申请

事项审批系统中的概念。对于某一个角色的审批人来说，某一个工程申请轮到该审批人审批了，这个事项叫做待办工程申请。

04

办结工程

事项审批系统中的概念。对于某一个角色的审批人来说，某一个工程申请已经被该审批人审批了，这个事项叫做办结工程。

05

Session〔会话〕

Session〔会话〕表示用户从向效劳器发送请求开始，直到用户关闭浏览器这段时间内的效劳器可以识别出用户的一个状态。

06

科技人才

公司内部业绩突出的员工

07

事项

立项、实施、验收、成果、奖励的申请和审批事件

08

科技工程

签订合同后开始实施的工程，包括正在实施的工程和已经完成的工程

09

科技成果

到达一定水平，有一定意义的成功工程

10

实施管理

工程开始实施后的中期阶段汇报

2编码标准

2.1命名标准

1.包名：采用统一的com.chinasoft.**.**的方式进行命名，**为小写字母组成的英文单词

描述。

2.类名：采用完整的英文描述，其中包含的每个单词都应紧靠在一起，每个单词首字母都

应该大写。

3.方法名：采用完整的英文描述，其中应包含生动的动词，包含的每个单词都应该紧靠在

一起，第一个单词首字母小写，其他单词首字母大写。

4.变量名：同方法名。

5.常量名：采用完整的英文描述，全部采用大写字母，相邻的字母之间使用下划线隔开。

6.JSP文件名：采用完整的英文描述，其中包含的每个单词都应该紧靠在一起，第一个单

词首字母小写，其他单词首字母大写。

例如：包名：com.chinasoft.action类名：ThisIsClassName方法名：thisIsMethodName

`常量名：MAX_SIZE

注：1.循环变量使用I,j,k或counter。

2.命名中用到information时一律使用info。

2.2注释规那么

注释包括文件注释、类注释、方法注释、行间注释。

1.文件注释：写在文件开头，标明作者、版本、最后更新时间、以及版权，如下所示，

/*

*刘成

*版本：V1.0

*最后更新时间：2010-7-1914:23

*中软国际版权所有

*/

2.类注释：写在类的声明之前，标明类的用途、作者、版本，如下所示，

/**

*TODO将文本文件读取成StringBuffer的一个类

*@versionv1.0

*@authoraimicheng

*/

3.方法注释：写在方法定义之前，标明方法的用途、参数、返回值以及抛出的异常，如下所

示，

/**

*TODO:读取文本文件内容到一个StringBuffer中

*@paramfile要读取的文本文件的文件系统中的路径

*@return返回一个包含文本文件中的文本内容的StringBuffer对象

*@throwsIOException

*/

4.行间注释：对于关键的局部进行注释。写在要注释的行之上，标明该行语句的用途，如下

所示，

//创