QR19-02 模块设计报告.doc

项目名称

模

块

设

计

报

告

宁波大榭招商国际码头有限公司

文档信息

项目名称：

项目编号：

项目负责人：

所属部门：

编制人：

编制时间：

审核人：

审核时间：

批准人：

批准时间：

版本号：

流水号：

修改记录

日期

版本

修改说明

修改者

目录

TOC\o1-3\h\z\u1 引言 4

1.1 文档目的 4

1.2 文档范围 4

1.3 读者对象 4

1.4 参考文献 4

1.5 术语与缩写解释 4

2 模块命名规则 5

3 模块汇总 5

3.1 模块汇总表 5

3.2 模块关系图 5

4 模块设计 5

4.1 XXX模块 5

4.1.1 设计说明（可选） 5

4.1.2 界面设计 5

4.1.3 协作图 5

4.1.4 算法说明（可选） 5

4.1.5 类设计（可选） 6

4.1.6 数据库表（可选） 6

5 其它（可选） 6

6 附录 6

引言

编写目的

[说明编写本模块设计报告目的，指出预期的读者。]

范围

[简要描述项目的范围。]

术语定义

[列出本文件中用到的专门术语的定义和外文首字母组词的原词组。]

参考资料

[列出用得着的参考资料，如：

a．本项目的经核准的计划任务书或合同、上级机关的批文等；

b．属于本项目的其他已发表的文件；

c．本文件中引用的文件、资料、包括所要用到的软件开发标准。

列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。]

模块命名规则

[模块设计人员确定本软件的模块命名规则（例如类、函数、变量等），确保模块设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用（如果存在的话）。]

模块汇总

模块汇总表

[参考架构设计总体功能架构。]

设计编号

子系统/模块名称

功能描述

对应的需求编号

SD01

XXXX

XXXX

SR01,SR02,SR05

XXXX

SD02

XXXX

XXXX

模块关系图

[参考体系结构设计文档]

包及类命名汇总表

[包命名规范，以com.esse.projects开头+项目名+细分的包名。参见QW20-02Java编码规范及实践]

一级包名

二级包名

包描述

接口或类命名

接口或类功能简要描述

lims.business

xxx

xxxxxx

xxxx

xxxx

xxx

xxxxxx

xxxx

xxxx

lims.utils

xxxxxx

…

.l..

….

[一级包名填项目名+大的包名，以lims做项目名为例，业务包命名为com.esse.projects。lims.business，工具包命名为com.esse.projects。lims.utils。二级及以下级包名根据设计人员自己设计要求命名，并描述其功能用途。]

[接口和类命名(对应二级及以下级包内的)，及其功能描述。表的内容比较挤，也可以分开成两张表独立描述，表头为：包名、接口或类命名、接口或类功能简要描述。]

[命名规则均要求遵循QW20-02Java编码规范及实践]

模块设计

XXX模块

设计说明（可选）

[对模块的设计进行文字说明。]

界面功能设计

[较复杂界面类用word或visio等工具简单画出界面。强调界面上具备的操作功能]

协作图

[较复杂功能画出协作图，简单的CRUD功能可以省略，复杂功能可以放多个协作图。若设计人员采用序列图表示交互行为，将该节改为序列图]

单元测试用例

[列出模块的单元测试要点]

算法说明（可选）

[对较复杂的成员方法的逻辑进行说明。]

类设计（可选）

[对涉及的类的属性和方法进行详细说明，考虑设计模式。]

数据库表（可选）

[列出需要访问的数据库表。]

其它（可选）

附录