当前位置:文档之家› 详细设计说明书模版

详细设计说明书模版

详细设计说明书模版
详细设计说明书模版

密级:机密

文档编号:XXX_TS_TEMP_XXSJSMS

版本号:V2.0

【项目名称】

详细设计说明书模板

编写人:XXX

批准人:XXX

生效日期:

2017年1月6日

版权信息

本文件涉及之信息,属XXX所有。

未经XXX允许,

文件中的任何部分都不能以任何形式向第三方散发。文档修订记录

版本号修订日

修订说明

审核日

审核

批准

V0.12016-12

-1XXX创建A2016-12

-1

XXX XXX

V1.02016-12

-28XXX调整需求分

析方法

M2016-12

-29

XXX XXX

V2.02017-1-

4XXX更换使用模

M2017-1-

6

XXX XXX

修订状态:A--增加,M--修改,D--删除日期格式:YYYY-MM-DD

目录

1 概述 (1)

1.1 编写目的 (1)

1.2 适用范围 (1)

1.3 术语和缩写 (1)

1.4 参考资料 (1)

2 角色和职责 (2)

3 设计约定 (2)

4 实现架构及功能逻辑 (2)

4.1 功能逻辑描述 (2)

4.1.1功能模块结构图 (2)

4.1.2功能模块描述 (3)

4.2 软件体系架构 (4)

4.2.1设计思路 (5)

4.2.2包图及描述 (5)

4.2.3类图及描述 (6)

4.2.4主要程序描述 (7)

4.2.5组件图及描述 (8)

4.2.6源代码目录结构 (8)

4.2.7权限设计 (9)

4.3 总体界面设计 (9)

4.3.1设计原则 (9)

4.3.2设计思路 (9)

4.3.3界面风格 (9)

4.3.4界面层次图 (10)

4.3.5界面原型 (10)

5 详细设计 (10)

5.1 模块A (11)

5.1.1概要说明 (11)

5.2.2实现框架 (12)

5.3.3主要逻辑实现描述: (13)

5.3.4界面设计 (17)

5.3.5接口设计 (17)

5.3.6其它 (17)

5.2 模块B (17)

6 数据库设计 (17)

7 接口设计 (18)

8 附录: (18)

1概述

1.1编写目的

<此处填写本文档的目的>

<例如:XXX项目的目的是:根据《XXX需求规格说明书》进行详细设计>

1.2适用范围

<此处填写本文档的适用范围等>

1.3术语和缩写

<此处填写本文档中所特有的术语和缩写,常用的术语和缩写统一编写在一个规范文档中>

术语和缩写解释备注

1.4参考资料

指出为完成本文档所需要的参考资料,包括

a属于本项目的其它已发表的文件;

b本文件中各处引用到的文件资料,包括所要用到的软件开发标准。

列出这些文件的标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。>

参考文件备注《XXXX项目需求规格说明书》

《XXXX项目系统概要设计报告》

2角色和职责

角色职责

项目经理●指导和审查数据库的详细设

系统分析员●负责数据库的详细设计

3设计约定

<说明系统设计需要遵循的一些约定和约束等。>

4实现架构及功能逻辑

4.1功能逻辑描述

<建议分层描述本系统功能模块,功能模块可包含面向用户需求的功能模块,也可包含面向实现的功能模块(如实现数据库的通用访问等),层次建议两到三层。

功能逻辑建议采用功能逻辑图+文字说明方式描述,功能逻辑图建议采用Visio组织机构图来画,功能模块描述建议采用分级标题,便于组织和检索。>

<样例:该例子分三个层次画出了三层功能模块,根据项目的实际情况,几层功能模块图可以画在一张上图上。>

4.1.1功能模块结构图

<样例

4.1.1.1顶层功能模块图

IdealFlow

工作流系统

流程定义管理及监控组织定义工作流引擎

4.1.1.2二层功能模块图

组织定义

部门定义个人设置单位名称维护部门岗位定义

4.1.1.3三层功能模块图

>

4.1.2功能模块描述

<样例

4.1.2.1组织定义

具体描述…

4.1.2.1.1单位名称维护

具体描述…

4.1.2.1.2部门定义

具体描述…

4.1.2.2流程定义

具体描述…

>

4.2软件体系架构

<该章节主要描述系统的实现的体系架构,以期使读者从总体上了解项目的设计框架。软件体系架构描述包括在物理上,对象之间通过函数或者过程调用相互作用;在逻辑上,对象之间通过集成、复合等方式实现设计的复用。该章节更多的内容面向编码和实现,对于不同的项目或采用不同的工具,设计文档使用的图示或工具可能不同,如面向对象的设计可以用高层次的类图、组件图、包图等和相关文字说明等描述整体的体系架构,面向过程的设计可能使用高层次的函数功能分解来描述,另外该章节内容也包括对源代码组成的高层次描述>

<软件体系架构描述中,另外很重要的是描述系统采用通用或核心的模块、组件的设计思路及实现框架(如对数据库访问的通用实现)。这些通用设计在此处以及在后续设计文档的集中描述,有利用读者的理解和阅读,也有利于设计文档的维护。> <面向编码和实现,描述如何组织代码实现相关业务逻辑。对于不同的项目或采用不同的工具,设计文档使用的图示或工具可能不同,如面向对象的设计可以用高层次的类图、组件图、包图等和相关文字说明等描述整体的体系架构,面向过程的设计可能使用高层次的函数功能分解来描述,另外该章节内容也包括对源

代码组成的高层次描述,建议的章节结构包括>

4.2.1设计思路

<描述系统总体设计采用的框架、工具、方法等,平台级的设计思路,以及对一些难点和复杂逻辑、权限等的处理思路> <对于通常的项目,设计思路可能包括多个部分,可以分子章节描述,如框架、权限、策略等等>

4.2.2包图及描述

<提示:直接通过数据库进行操作的统计报表类系统该部分可以不描述>

<主要创建类包图,通过层次结构,以在逻辑上组织设计,在使用包图及描述中,要能体现设计和功能逻辑间的关系> <一些建议,把一个框架的所有类放置在相同的包中。一般把相同继承层次的类放在相同的包中。彼此间有聚合或组合关系的类通常放在相同的包中。彼此合作频繁的类,信息能够通过UML 顺序图和UML合作图反映出来的类,通常放在相同的包中。> <对于通常的项目,包图可能有多个,可以分子章节描述>

<样例,类包图示意,缺少描述>

4.2.3类图及描述

<提示:直接通过数据库进行操作的统计报表类系统,Sieble 套件类系统该部分可以不描述>

<主要创建类包图,通过层次结构,以在逻辑上组织设计,在使用类图及描述中,要能体现设计和功能逻辑间的关系。> <此章节类图描述系统实现的高层次主要类以及它们自己的

关系(如继承、聚合等),并描述出这些类的主要作用,此章节对属性和方法不需要太细化。>

<对于通常的项目,类图可能有多个,可以分子章节描述> <样例,类图示意,缺少描述>

4.2.4主要程序描述

<主要适合面向过程类设计或项目中复杂的逻辑处理,通过图释和说明描述项目中主要的函数功能以及调用关系,对函数的细节不需要太细化。>

<对于通常的项目,主要程序可能有多个,可以分子章节描述> 4.2.5组件图及描述

<组件图,目的和“主要程序描述”相同,可以根据实际情况选择使用>

<样例,组件图示意,非面向对象设计也可以有组件图,缺少描述>

4.2.6源代码目录结构

<以树型结构并结合描述描述出系统的较高层次的源代码目录结构,以便读者能很快理解项目程序结构的组织,目录层次的颗粒度应到覆盖到各需求功能模块、核心体系架构的实现(基本可以和上面的设计文档描述的层次相当。>

<样例,仅供参考

XXX项目

源代码

业务功能A 登记模块,并初始化

业务功能A1

业务功能B

打印组件打印模块,实现打印的通用功能图片库

>

4.2.7权限设计

<说明该系统在权限设计的总体考虑。>

4.3总体界面设计

<提示:后台接口类的项目该部分可以不写>

4.3.1设计原则

<该项目中界面设计的要求、限定等设计中要注意的原则> 4.3.2设计思路

<该界面实现的设计思路,如使用XML形成界面菜单,采用CSS 提供多套样式风格等>

4.3.3界面风格

<界面的风格,如配色、操作等方面的考虑>

4.3.4界面层次图

<较高层次的界面的层次图,如建议和功能逻辑的层次相当> 4.3.5界面原型

<界面草图或美工设计的界面原型,可有主界面级、视图级、表单级等>

5详细设计

<详细设计是将“实现架构及功能逻辑”章节中功能逻辑、体系架构的内容在实现上的细化,以在更深的层次上分解功能逻辑和实现逻辑,整体的章节结构随着功能的细化可以看作对“实现架构及功能逻辑”的迭代和细化,但子模块的顶级章节层次仍采用二级标题层次。对于该章节采用的描述工具和方法,“实现架构及功能逻辑”使用的许多工具仍能适用,但该章节更面向具体的实现逻辑,根据不同的项目和使用的工具,可采用如流程图、顺序图、协作图等等来描述实现的细节。>

<该章节的基本面向以编码为主的项目,对于许多集成类的项目,如Notes邮件配置、Tivoli单点登录实现,也建议按功能模块来划分,参考以下章节的内容,适当调整章节结构,根据情况增加一些相关的图示和描述,以表达清楚该功能的实现设计。如Notes的Internet邮件配置,需要描述邮件系统设计思路、拓扑框架及相关的配置文档;Tivoli的单点登录实现,需要描述每个相关系统采用哪种单点登录模式,应用系统和服务器相应的改变、相关的配置等等。>

<对于章节的细分,根据需求分析设计的模式可以有不同的方式,如采用功能模块分解或主题域分解。对于目前的多数项目,虽然可能采用面向对象的语言实现,但我们多数采用面向过程的功能分解,一般建议子章节的结构采用功能逻辑分解。对于一些业务或实现上通用的功能及模块建议单独列出,集中描述。> <对于较大的项目,如采用不同模块采用不同技术路线开发或功能组织分为几个大类,可采用分文档描述,也可在一个文档中描述。如果在一个文档中描述,大类的详细设计可采用一级标题,如5.公文管理详细设计、6.门户详细设计>

5.1模块A

5.1.1概要说明

<本模块的功能简述,如有多级层次,建议分层描述相关子模块。可采用图示或文字说明,建议以文字说明为主,功能描述可以分子章节>

<样例,简单

向内核系统登记几个proc文件,以便于向内核空间中查询安全联盟和eoute表,以及虚接口的状况;

初始化SA数据库(tdb链);

初始化SPDB数据库(eroute表);

初始化pf_key(PF_KEY套接口);

>

<样例,子章节

组织定义:

具体描述…

单位名称维护:

具体描述…

部门定义:

具体描述…

流程定义:

具体描述…

>

5.2.2实现框架

<以下的章节结构目的是从不同的维度和视图来描述设计,供参考。实际项目中可进行扩展和裁剪,建议大家学习UML的各种图示,统一采用UML图示来表达设计方面的各种视图>

设计思路:

<描述该总体设计采用的框架、工具、方法等,以及对一些难点和复杂逻辑的处理思路>

<对于通常的项目,设计思路可能包括多个部分,可以分子章节描述>

包图及描述:

<提示:数据库操作类的项目该部分可以不描述>

<该类包图,通过层次结构,以在逻辑上组织设计,在使用包图及描述中,要能体现设计和功能逻辑间的关系>

类图及描述:

<提示:数据库操作类的项目,Sieble套件类系统该部分可以不描述>

<该模块的类图,通过层次结构,以在逻辑上组织设计,在使用类图及描述中,要能体现设计和功能逻辑间的关系,同“实现架构及功能逻辑”章节不同,该章节将深入描述类实现的细节,如方法、属性等等。如果该模块比较复杂,可以分子章节来描述,并在子章节中细化设计>

设计的文件清单结构

<以树型结构并结合描述描述出系统的较高层次的源代码目录及文件结构,以便读者能很快理解模块程序结构的组织,颗粒度应到覆盖到主要的代码。>

<样例,仅供参考

XXX模块

源代码

业务功能A 登记模块,并初始化

业务功能A1

业务功能B

打印组件打印模块,实现打印的通用功能图片库

>

5.3.3主要逻辑实现描述:

<描述逻辑功能的实现,包括类方法或函数实现。此章节的内容可能是设计的重点,对于不同的实现,可采用不同方式描述。如使用UML图示中的合作图、活动图进行动态建模。但对于过程的细节描述仍建议采用传统的方式,描述程序实现的数据结构、算法和流程逻辑。对于此章节的组织,需要从实现的业务逻辑入手,而不要突然跳出一个图来,章节要有整体感。>

<样例1,顺序图>

账户间转帐

顺序图:

文字描述…

<样例2,典型的过程设计文档>

登记及初始化

变量说明

1)d evice结构

static struct device dev_ipsec0 =

{

"ipsec0\0 ", /* name */

NULL, /* next device */

ipsec_tunnel_probe /* setup */

};

2)数据结构2.

3)…

函数说明

1)v oid call_server(void)

<功能:说明该程序应具有的功能,可采用IPO图(即输入一处理一输出图)的形式。>

功能:监听SA协商消息――IKE消息、whack消息和pfkey 消息,收到上述几种消息后,再调用相应处理模块。

<性能:说明对该程序的全部性能要求,包括对精度、灵活性和时间特性的要求。>

性能:无

<输入项:给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。>输入项:无

<输出项,给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。>输出项:无

<算法,详细说明本程序所选用的算法或流程,包括具体的计算公式和计算步骤,可用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程,也可以用伪代码来表示流程逻辑>

算法:

1.调用函数init_pfkeyed(),创建PF_KEY类型的套接口;

2.调用函数init_whackfd(),创建AF_UNIX型套接口,用于通信;

2.进入循环等待,接收到来的消息:

如果收到IKE协商消息,调用函数comm_handle()处理;

如果收到whack消息,调用函数whack_handle()处理;

如果收到pfkey消息,调用函数pfkey_handle()处理。

2)函数2

…..

5.3.4界面设计

<说明该模块的界面的设计思路和设计元素。设计思路包括界面草图、界面层次,界面风格等。若无或在其它文档描述,可略>…

界面层次图

界面原型

<该模块的界面原型>

5.3.5接口设计

<说明该模块和其它模块间存在的接口,反映调用和被调用,数据传递。如果在其它设计中已包含的接口实现,此处引用即可。>

5.3.6其它

<其它需要说明的设计内容,一些和设计实现有关的非代码性的内容等等。>

5.2模块B

6数据库设计

(完整版)软件详细设计说明书模板

软件详细设计说明书 v1.0 200X年月XX日 修订历史记录

编制 审查 审核 批准 文档评审负责人:参加评审人员:

目录 1引言 (4) 1.1编写目的 (4) 1.2背景 (4) 1.3定义 (4) 1.4设计依据 (4) 2软件系统结构 (4) 2.1功能需求 (4) 2.2子模块划分 (4) 2.3子模块间关系 (4) 3公共数据结构 (4) 4程序设计说明 (5) 4.1程序1设计说明 (5) 4.1.1程序描述 (5) 4.1.2功能 (5) 4.1.3性能 (5) 4.1.4输入 (5) 4.1.5输出 (5) 4.1.6算法 (5) 4.1.7流程 (5) 4.2程序2设计说明 (5) 5模块重用说明 (5)

1引言 1.1编写目的 〖说明编写这份软件详细设计说明书的目的〗 1.2背景 〖说明待开发软件(子)系统的名称和此软件(子)系统所属大系统的名称; 说明任务的来源(开发背景和市场背景)等;该软件(子)系统与大系统中其他子系统的关系。〗 1.3定义 〖列出本文档中所用到的专门术语的定义和缩写词的原意〗 1.4设计依据 〖列出本文档所引用的有关设计依据(标题、文件编号、版本号、作者、发布日期、出版单位),包括本项目内部已编写的有效文档、出版刊物和国家标准或规范〗2软件系统结构 2.1功能需求 2.2子模块划分 〖说明本软件系统(或模块)的实现,即其内部的子模块划分(给出程序的名称和标识符)。建议以图形说明。〗 1.XXXXXXXX 2.XXXXXXXX 3.XXXXXXXX 4.XXXXXXXX 5.XXXXXXXX 6.XXXXXXXX 2.3子模块间关系 〖说明各子模块间的控制、顺序等耦合关系。〗 3公共数据结构 〖给出本软件系统使用的每一个公共数据结构的类型定义、存储方式,公共数据结构内各元素项的类型定义、初始取值、可能取值的范围及相应的物理含义。建议以类似C语言的数据说明格式来描述。〗

系统详细设计说明书

文档标题 文档编号BH-CSD-003 版本V1.0 密级商密 A 研发生产中心项目名称全科医生专家咨询系统 项目来源 系统详细设计说明书 (V1.0 ) 南京毗邻智慧医疗科技有限公司 二○一三年十一月

文档变更记录 序号变更( +/- )说明作者版本号日期批准1 创建Steve.ma V1.0 2013.11.15 1 引言.......................................................................... (3) 1.1 编写目 的 ......................................................................... (3) 1.2 背 景 .......................................................................... (3) 1.3 定 义 .......................................................................... (3) 1.4 参考资 料 ......................................................................... (4) 2 平台安全体系与程序系统的结构........................................................................................ (4) 2.1 平台安全体 系 ........................................................................ (4) 2.2 程序系统结 构 ........................................................................ (5) 3 程序设计说 明 ........................................................................... (5) 3.1 程序描 述 ......................................................................... (5) 功能及其接 口 ........................................................................

项目开发详细设计说明书(超好用模板)完整版

详细设计说明书XX有限公司

修订记录

目录 第一章概述........................................................................... 错误!未定义书签。 1.1.应用模块的目的....................................................... 错误!未定义书签。 1.2.应用模块总体描述................................................... 错误!未定义书签。 1.3.应用模块接口描述................................................... 错误!未定义书签。 1.4.假设条件................................................................... 错误!未定义书签。第二章设计模式(Design pattern) ................................... 错误!未定义书签。第三章类设计....................................................................... 错误!未定义书签。 3.1.分块类图................................................................... 错误!未定义书签。 <类图1> ............................................................ 错误!未定义书签。 <类图n> ............................................................ 错误!未定义书签。 3.2.整体继承关系........................................................... 错误!未定义书签。 3.3.类描述....................................................................... 错误!未定义书签。 <类名1> Class Description............................. 错误!未定义书签。 <类名n> Class Description............................. 错误!未定义书签。第四章交互图....................................................................... 错误!未定义书签。 4.1.<情景编号1: 情景名称> ........................................ 错误!未定义书签。 交互图................................................................ 错误!未定义书签。 例外情况及条件................................................ 错误!未定义书签。 4.2.<情景编号n: 情景名称> ........................................ 错误!未定义书签。第五章状态图....................................................................... 错误!未定义书签。 5.1.<状态图编号1:状态图名称> .................................. 错误!未定义书签。 5.2.<状态图编号n:状态图名称> .................................. 错误!未定义书签。第六章时序流程图............................................................... 错误!未定义书签。第七章用户界面设计说明................................................... 错误!未定义书签。 7.1.用户界面关系........................................................... 错误!未定义书签。 7.2.用户界面具体描述................................................... 错误!未定义书签。 <界面编号1:界面名称〉 ................................. 错误!未定义书签。 <界面编号N:界面名称〉 ................................ 错误!未定义书签。

网上购物系统——详细设计说明书

网上购物系统 详细设计说明书 1引言 1.1编写目的 电子商务是于九十年代初,在欧美兴起的一种全新的商业交易模式,它实现了交易的无纸化,效率化,自动化表现了网络最具魅力的地方,快速的交换信息,地理界限的模糊,这所有的一切也必将推动传统商业行为在网路时代的变革。随着电子商务,尤其是网上购物的发展,商品流通基础设施和配套行业的重点将会将对中国商品流通领域和整个经济发展带来种种影响,确实值得我们认真研究。特别是在全球经济一体化的国际背景下,在我们继续扩大国内流通领域对外开放的同时,深入研究这个问题,审慎制订相应的宏观对策,尤其重要和迫切。网上购物是一种具有交互功能的商业信息系统。它向用户提供静态和动态两类信息资源。所谓静态信息是指那些比经常变动或更新的资源,如公司简介、管理规范和公司制度等等;动态信息是指随时变化的信息,如商品报价,会议安排和培训信息等。网上购物系统具有强大的交互功能,可使商家和用户方便的传递信息,完成电子贸易或EDI交易。这种全新的交易方式实现了公司间文档与资金的无纸化交换。 1.2.项目背景 软件名称:网上购物系统 开发者:宋金德,袁浩,王朝阳,许威 项目简介:本系统主要实现网上产品展示与在线定购及人员的管理, 一、不同身份有不同的权限功能(管理人员、注册用户、游客) 二、在线产品展示(分页显示) 三、在线定购 四、后台管理(用户管理、商品的管理) 1.3定义 Asp(active server pages)是微软公司推出的一种用以取代CGI的技术,基于目前绝大多数网站应用于windows平台,asp是一个位于windows服务器端的脚本运行环境,通过这种环境,用户可以创建和运行动态的交互式的web服务器应用程序以及EDI(电子数据交换)。 ADO:ActiveX Data Object, ActiveX 数据对象 SQL:Structured Query Language 1.4参考资料 [1] 谭浩强《动态网页制作ASP》北京电子工业出版社. 2001 [2] 彭万波《网页设计精彩实例》北京电子工业出版社.2002

软件系统详细设计说明书模板

xxxxx系统详细设计说明书

版本历史

修改记录

目录 1引言 (5) 1.1编写目的 (5) 1.2背景 (5) 1.3参考资料 (5) 1.4术语定义及说明 (5) 2设计概述 (5) 2.1任务和目标 (5) 2.1.1需求概述 (5) 2.1.2运行环境概述 (5) 2.1.3条件与限制 (6) 2.1.4详细设计方法和工具 (6) 3系统详细需求分析 (6) 3.1详细需求分析 (6) 3.2详细系统运行环境及限制条件分析接口需求分析 (6) 4总体方案确认 (6) 4.1系统总体结构确认 (6) 4.2系统详细界面划分 (7) 4.2.1应用系统与支撑系统的详细界面划分 (7) 4.2.2系统内部详细界面划分 (7) 5系统详细设计 (7) 5.1系统程序代码架构设计 (7) 5.1.1UI(User Interface)用户界面表示层 (7) 5.1.2BLL(Business Logic Layer)业务逻辑层 (8) 5.1.3DAL(Data Access Layer)数据访问层 (8) 5.1.4Common类库 (8) 5.1.5Entity Class实体类 (8) 5.2系统结构设计及子系统划分 (8) 5.3系统功能模块详细设计 (9) 5.3.1XX子系统 (9) .1XX模块 (9) 列表和分页 (9) 创建XX (9) .2XX模块 (9) XX列表 (9) XX修改 (9) 5.3.2XX子系统 (9) 5.3.6.1用户管理模块 (9) 5.3.6.2角色管理模块 (14) 5.3.6.3系统设置模块 (14) 5.3.6.4系统登录注销模块 (14) 5.4系统界面详细设计 (14) 5.4.1外部界面设计 (14) 5.4.2内部界面设计 (14) 5.4.3用户界面设计 (14) 6数据库系统设计 (14) 6.1设计要求 (14) 6.2信息模型设计 (14) 6.3数据库设计 (14) 6.3.1设计依据 (14)

详细设计方案说明书模版

密级:机密 文档编号:XXX_TS_TEMP_XXSJSMS 版本号:V2.0 【项目名称】 详细设计说明书模板 编写人:XXX 批准人:XXX 生效日期:2017年1月6日 版权信息 本文件涉及之信息,属XXX所有。 未经XXX允许, 文件中的任何部分都不能以任何形式向第三方散发。

文档修订记录 版本号修订日期修订 人 修订说明 修订 状态 审核日期审核人批准人 V0.12016-12-1XXX创建A2016-12-1XXX XXX V1.02016-12-28XXX调整需求分析方法M2016-12-29XXX XXX V2.02017-1-4XXX更换使用模板M2017-1-6XXX XXX 修订状态:A--增加,M--修改,D--删除 日期格式:YYYY-MM-DD

目录 1 概述 (1) 1.1 编写目的 (1) 1.2 适用范围 (1) 1.3 术语和缩写 (1) 1.4 参考资料 (1) 2 角色和职责 (1) 3 设计约定 (1) 4 实现架构及功能逻辑 (1) 4.1 功能逻辑描述 (1) 4.1.1功能模块结构图 (2) 4.1.2功能模块描述 (2) 4.2 软件体系架构 (3) 4.2.1设计思路 (3) 4.2.2包图及描述 (4) 4.2.3类图及描述 (5) 4.2.4主要程序描述 (6) 4.2.5组件图及描述 (6) 4.2.6源代码目录结构 (7) 4.2.7权限设计 (7) 4.3 总体界面设计 (8) 4.3.1设计原则 (8) 4.3.2设计思路 (8) 4.3.3界面风格 (8) 4.3.4界面层次图 (8) 4.3.5界面原型 (8) 5 详细设计 (8) 5.1 模块A (9) 5.1.1概要说明 (9) 5.2.2实现框架 (10) 5.3.3主要逻辑实现描述: (11) 5.3.4界面设计 (13) 5.3.5接口设计 (13) 5.3.6其它 (13) 5.2 模块B (14) 6 数据库设计 (14) 7 接口设计 (14) 8 附录: (14)

详细设计说明书模版

(项目名称)详细设计说明书 文件版本 编写日期 发布日期

文件修改记录 修改日期版本号变化状态修改内容修改人 *变化状态:C――创建,A——增加,M——修改,D——删除 文档审批信息 版本号提交人批准人批准日期发布日期备注

目录 1引言 (1) 1.1编写目的 (1) 1.2适用范围 (1) 1.3术语和缩写 (1) 1.4参考资料 (1) 2概述 (1) 2.1系统概述 (1) 2.2系统功能定义 (1) 3总体结构说明 (1) 3.1系统结构 (1) 3.1.1系统内外部关系图 (1) 3.1.2功能模块简要说明 (1) 3.1.3依赖的外部接口 (1) 3.1.4对外提供的接口 (1) 3.2模块程序构件结构图 (1) 4数据模型(Data Model)设计 (2) 4.1逻辑实体模型 (2) 4.1.1实体模型1 (2) 4.1.2实体模型2 (3) 4.2表结构(物理设计) (3) 4.2.1表汇总 (3) 4.2.2表1 (3) 4.2.3表2 (3) 4.3视图列表 (4) 5功能实现说明 (4) 5.1数据流类模块 (4) 5.1.1数据流程图 (4) 5.1.2实现说明 (4) 5.1.3程序设计 (4) 5.2业务处理类模块 (5) 5.2.1Object Model设计 (5)

5.2.2程序设计 (5) 6界面实现说明 (5) 6.1模块1 (5) 6.1.1总体界面结构(业务操作区)说明 (5) 6.1.2功能点1界面结构说明 (5) 6.1.3功能点2界面结构说明 (5) 6.2模块2 (6) 6.2.1总体界面结构(业务操作区)说明 (6) 6.2.2功能点1界面结构说明 (6) 6.2.3功能点2界面结构说明 (6)

系统软件详细设计说明书

系统软件详细设计说明书 1.引言 1.1编写目的 本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详 细设计,在概要设计的基础上进一步明确系统结构,详细地介绍系统的各个模块,为进行后面的实现和测试作准备。本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣,在以后想对系统进行扩展和维护的人员。 2.系统的结构 ui :系统界面部分,负责接受用户输入,显示系统输出,负责其他模块功能的协调调用,并含有站内搜索功能,即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui 部分调用common部分的功能读取xml文件中保存的界面元素属性信息,用户最近访问过的10个ftp信息,用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。 client :实现ftp客户端的功能,ftp连接,ftp上传及下载:上传或下载用户指定的

资源,并返回相应的信息。 search: 资源实时检索部分,根据用户输入的资源名称关键字,资源类型和选择的检索方式检索用户需要的资源,并验证资源的可用性,返回可用资源及其大小,速度等相关信息。 preview :资源预览部分,显示用户选择的资源的部分内容,以使用户决定是否需要该资源。 preview部分调用comm on部分读取属性文件的内容亦显示预览资源内容的显示格式。 3.模块1(ui )设计说明 3.1 模块描述实现用户界面的包,含有11个文件51 个类,是本系统中最复杂的代码。 3.2 功能负责接受用户输入,显示系统输出,其他模块功能的协调调用,并含有站内搜索功能,即在用户指定的已打开的ftp 站点中搜索用户需要的资源。 3.3 交互的模块 client ,search ,preview ,common。 3.4 模块设计该模块中的主要文件,文件中包含的主要类及其功能和与其它包的交互如下: MainFrame.java :MainFrame 是含有主函数的类,也是lyra 客户端开始执行的类,它先后进行资源的初始化,显示主界面等工作,根据屏幕大小设置界面大小,设置界面的观感。 FtpFrame_AboutBox.java: 显示关于窗口的类,当用户点击帮助菜单中的关于菜单项时会 弹出关于对话框。 Tools.java :FileTools 是文件操作辅助类,可以实现文件的递归删除等。 XMLController.java: JDOMTes是操作xml文件的类,用JDOM来操作xml文件, 实现的功能有: (1)保存ftp 服务器的文件列表(站内搜索时使用),递归的从ftp 服务器读取列表,并存入一个xml文件中(文件的命名方法是:ip+用户名.xml);以目录树的形式保存。 (2)根据文件名在文件中查找文件,站内搜索时使用。 (3)保存ftp 服务器的信息:ip ,端口(默认端口21 不保存),用户名(默认anonymous 不保存),密码,最多存10 个;存在resource\settings\ serversinfor.xml 文件中。 (4)读取已存储的ftp 服务器信息。 (5)从type.xml 读取搜索的类型。 Constants.java: 放置系统运行时使用的一些常量,initcontent ()函数对所有常量进行初始化,这个函数在MainFrame 中被调用一次。iconHashMap 是hash 表,用于存放文件的系统图标。 CustomizedController.java :包含自定义的控件类,java 中的控件可能不能满足需求,需要自己定义某些属性。这些控件会在创建界面时使用。其中含有的类有: (1)CustomizedJTable 是表格类,设置表格的某些属性,如字体等。 (2)CustomizedTableCellRenderer 是表格单元格绘制器类,主要用于显示文件的系统图标,和文件名。 (3)LeftPanel类的父类是JTabbedPane,用户显示主窗口左边的面板。 (4)RightPanel 类的父类是JPanel ,用户显示右边的主题部分,包括右上边的搜索及服务 器选项,和中间的显示服务器文件的TabbedPane。. (5)BottomPanel 类是右下放显示下载和服务器信息的JTabbedPane。 (6)CustomizedJButton 是定义按钮类,更改了按钮的字体,java 本身默认的字体不好看。 (7)CustomizedTableModel 是表格类,实现单元格的不可编辑。 (8 )CustomizedTableCellRenderer_Remote 类是表格绘制器,在远程文件浏览 器RemoteFilesPanel 使用,用于显示文件名和文件图标。

详细设计说明书模板

详细设计说明书广东创我科技发展有限公司

修订记录

目录 第一章概述 (5) 1.1. 应用模块的目的 (5) 1.2. 应用模块总体描述 (5) 1.3. 应用模块接口描述 (5) 1.4. 假设条件 (5) 第二章设计模式(Design pattern) (6) 第三章类设计 (7) 3.1. 分块类图 (8) 3.1.1. <类图1> (8) 3.1.2. <类图n> (8) 3.2. 整体继承关系 (8) 3.3. 类描述 (9) 3.3.1. <类名1> Class Description (9) 3.3.2. <类名n> Class Description (10) 第四章交互图 (12) 4.1. <情景编号1: 情景名称> (12) 4.1.1. 交互图 (12) 4.1.2. 例外情况及条件 (13) 4.2. <情景编号n: 情景名称> (13) 第五章状态图 (14) 5.1. <状态图编号1:状态图名称> (14)

5.2. <状态图编号n:状态图名称> (15) 第六章时序流程图 (16) 第七章用户界面设计说明 (18) 7.1. 用户界面关系 (18) 7.2. 用户界面具体描述 (18) 7.2.1. <界面编号1:界面名称〉 (18) 7.2.2. <界面编号N:界面名称〉 (19) 第八章测试考虑 (20) 第九章附录 (21) 9.1. 附录A 代码举例 (21) 9.2. 附录B 设计问题 (21) 9.2.1. <设计问题1> (21) 9.2.2. <设计问题n> (21)

第一章概述 1.1.应用模块的目的 请明确客户建立应用模块的目的。 1.2.应用模块总体描述 描述应用模块的总体功能。 1.3.应用模块接口描述 简要描述本应用模块的公共接口,具体接口会在相应的类中进行具体描述。建议采用列表的方式。 1.4.假设条件 列出在问题领域,项目方案及其它影响系统设计的可能方面内,应当成立的假设条件。包括系统的约束条件和应遵循的标准。

详细设计说明书模板

修订历史记录 【模板使用必读:模板内容和页眉中【】包含内容为指导性的待替换文字,请在使用中替换为具体内容,或删除。文件提交时不得再含有这些内容。】

目录 1引言 (4) 1.1编写目的 (4) 1.2背景 (4) 1.3术语与缩写解释 (4) 1.4参考资料 (4) 2模块命名规则 (4) 3程序系统的组织结构 (5) 3.1子系统划分 (5) 3.2模块划分 (5) 3.3程序与功能需求、系统模块间的关系 (5) 4程序1(标识符)设计说明 (5) 4.1程序描述 (5) 4.2功能 (6) 4.3性能 (6) 4.4输人项 (6) 4.5输出项 (6) 4.6算法 (6) 4.7流程逻辑 (6) 4.8接口 (6) 4.9存储分配 (7) 4.10注释设计 (7) 4.11限制条件 (7) 4.12尚未解决的问题 (7) 5程序2(标识符)设计说明 (7)

引言 编写目的 【给出项目详细设计说明书的编写目的,同时指明读者对象。】 背景 【说明: a.待开发软件系统的名称; b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。】 术语与缩写解释 【列出本文件中用到的专门术语的定义和外文首字母缩写的原词组。】 参考资料 【提示:可包括:(1)本项目经核准的计划任务书、需求规格说明书、合同、项目设计概要说明书或上级机关的批文;(2)本文档所引用的资料、规范等,列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。】

模块命名规则 【确定本软件的模块命名规则,例如类、函数、变量等,确保设计文档的风格保持一致。可以从机构的编码规范中摘取或引用。】 程序系统的组织结构 【用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间的层次结构关系。】 子系统划分 模块划分 程序与功能需求、系统模块间的关系 程序1(标识符)设计说明 【从本章开始,逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即

系统详细设计说明书

XXXXXX XXXXXXXXXXXXX 项目名称 详细设计说明书 XXX公司 二〇XX年X月

文档修改记录

目录 第一章引言............................................. 错误!未定义书签。 目的............................................. 错误!未定义书签。 背景............................................. 错误!未定义书签。 术语定义......................................... 错误!未定义书签。 参考资料......................................... 错误!未定义书签。第二章系统概述......................................... 错误!未定义书签。第三章程序1设计说明................................... 错误!未定义书签。 程序描述......................................... 错误!未定义书签。 模块架构图 ................................... 错误!未定义书签。 功能 ......................................... 错误!未定义书签。 类图 ......................................... 错误!未定义书签。 增加功能(功能点) ........................... 错误!未定义书签。 程序流程 ..................................... 错误!未定义书签。 测试和限制条件 ............................... 错误!未定义书签。 备注 ......................................... 错误!未定义书签。第四章程序2设计说明................................... 错误!未定义书签。第五章公用接口程序说明................................. 错误!未定义书签。 全局变量......................................... 错误!未定义书签。 公用界面或接口................................... 错误!未定义书签。 公用方法和过程................................... 错误!未定义书签。第六章附件............................................. 错误!未定义书签。详细设计评审意见.......................................... 错误!未定义书签。

LLD详细设计说明书模板

XX 详细设计说明书 拟制日期yyyy-mm-dd 评审人日期yyyy-mm-dd 批准日期yyyy-mm-dd <公司或企业图标> <公司或企业中英文名称> 版权所有侵权必究 (仅供内部使用)

修订记录 分发记录

目录 1简介 (6) 1.1目的 (6) 1.2范围 (6) 2详细设计 (6) 2.1模块1详细设计 (6) 2.1.1数据描述 (6) 1.简单数据描述; (6) 2.结构1 (6) 3.结构2 (7) 2.1.2函数描述 (8) 1.函数1 (8) 2.函数2 (9) 2.2模块2详细设计 (10) 2.3错误处理 (10) 2.3.1系统错误 (10) 2.3.2接口错误 (10) 2.3.3协议错误 (10)

表目录No table of contents entries found.图目录 Figure 1Module 1 Structure Chart 模块1结构图 (8)

XX 详细设计说明书 关键词: 摘要: 缩略语清单:<对本文所用缩略语进行说明,要求提供每个缩略语的英文全名和中文解释。

1 简介 1.1 目的 描述本文的目的,一般详细设计必须能够直接指导编码活动。 1.2 范围 本节应描述文档所包括和不包括的内容。 2 详细设计 对于在概要设计说明书中给出的软件实体,本节集中描述它们的详细描述部分。 2.1 模块1详细设计 描述模块中定义和使用的数据,包括: 简单数据,如模块级的全局变量、常量、宏; 复合数据,如模块内部的结构、联合...; 2.1.1 数据描述 在2.1.1.1中描述本模块中的简单变量、常量、宏; 从2.1.1.2起描述本模块中的复合数据,如结构、联合等; 1. 简单数据描述; 描述在本模块中定义和使用的简单变量、常量、宏; 按照下列格式进行简单数据的描述 功能描述:描述该数据的用途 数据定义:定义该数据 2. 结构1 定义和说明该数据结构(包括联合); 按照下列格式进行数据结构的描述 数据结构描述:描述该数据结构的用途 数据结构定义:用实际的编程语言定义该数据结构 数据项描述:

详细设计说明书_模板

文档作者: 文档呈送: 文档抄送: XX项目 详细设计说明书 编写: 审核: 批准: 参与评审:

变更记录 版本号变化状态修改点说明变更人存放位置审批人审批日期 *变化状态:C――创建,A——增加,M——修改,D——删除 修改点说明:对变化状态进行简单解释,如增加了某项功能,修改了某个模块等信息。不允许出现“根据评审意见修改等字样” 注:当文档未评审通过前版本号标识规则为V0.X ,第一次评审通过后,版本号直接升级为V1.0,之后变更按照V1.X升级。

目录 1前提和约束 (4) 编写目的 (4) 预期读者和阅读建议 (4) 定义、缩写词、略语 (4) 参考资料 (5) 2前提和约束 (6) 前提条件 (6) 限制和约束 (6) 3综合描述 (6) 3.1系统目标 (6) 3.2系统需求 (6) 3.3系统概述 (7) 3.4程序结构说明 (7) 3.5源程序及编译链接组装说明 (7) 4系统详细设计 (7) 4.1XXX子系统名称 (8) 4.1.1XXX包名称 (9) 4.2XXX子系统名称2 (10) 5用户界面详细设计(可裁剪) (10) 5.1界面结构 (11) 5.1.1界面结构或菜单结构 (11) 5.1.2用户界面图(如无此需要,可省略) (11) 5.2界面处理流程及界面约束描述(如无此需要,可省略)错误!未定义 书签。 5.2.1界面或模块名1................................................. 错误!未定义书签。 5.2.2处理流程............................................................ 错误!未定义书签。 5.2.3界面约束与事件约束........................................ 错误!未定义书签。 5.2.4触发方式 (12) 5.2.5界面或模块名2................................................. 错误!未定义书签。6尚未解决的问题 (13) 7资源对象说明 (13)

网上购物系统详细设计说明书

五、详细设计说明书 1.引言 (222) 1.1编写目的 (222) 1.2项目背景 (222) 1.3定义 (333) 1.4参考资料 (333) 2.总体设计 (444) 2.1需求概述 (444) 2.2软件结构错误!未定义书签。错误!未定义书签。错误!未定义书签。 3.程序描述 (444) 3.1功能 (444) 3.2性能 (777) 3.3输入项目 (888) 3.4输出项目 (888) 3.5算法 (888) 3.6程序逻辑 (888) 3.7接口 (999) 3.8存储分配错误!未定义书签。错误!未定义书签。错误!未定义书签。

3.9限制条件错误!未定义书签。错误!未定义书签。错误!未定义书签。 3.10测试要点 (131313) 1.引言 1.1目的 为了对本网上购物系统的可行性进行一下探讨,论证实现本项目的可能性,和一些前期的准备工作及工作条件,并且为工程的下一步设计打下铺垫。电子商务是于九十年代初,在欧美兴起的一种全新的商业交易模式,它实现了交易的无纸化,效率化,自动化表现了网络最具魅力的地方,快速的交换信息,地理界限的模糊,这所有的一切也必将推动传统商业行为在网路时代的变革。随着电子商务,尤其是网上购物的发展,商品流通基础设施和配套行业的重点将会将对中国商品流通领域和整个经济发展带来种种影响,确实值得我们认真研究。网上购物是一种具有交互功能的商业信息系统。它向用户提供静态和动态两类信息资源。所谓静态信息是指那些比经常变动或更新的资源,如公司简介、管理规范和公司制度等等;动态信息是指随时变化的信息,如商品报价,会议安排和培训信息等。网上购物系统具有强大的交互功能,可使商家和用户方便的传递信息,完成电子贸易或EDI 交易。这种全新的交易方式实现了公司间文档

详细设计说明书模版

**有限公司 {公司名+项目名} 详细设计说明书 当前版本: 发布日期: 摘要 简要描述该文档的内容。

修改历史

目录 1概述 (4) 2结构图 (4) 3数据结构 (4) 4功能模块详细描述 (4) 5需求以及设计跟踪表 (4)

1概述 本章描述详细设计将实现的内容,以及受影响的子系统。假如用了软件图形工具,本章必须包含完整的软件图形模块目录的路径名。 2结构图 软件系统功能模块的图形描述,它可以让读者对功能模块有一个全面的了解。同时,它也提供了一个有用的索引及一个有意义的调试和维护指南。 数据必须显示在结构图中,同时,流程线应指明模块访问存储区的目的(读、写或修改)。 必须解释所有的用符号表示的内容(包括模块、参数和数据存储区等)。 3数据结构 ?如果某一数据类型由其它的数据类型组成,要保持信息上的一致性。 ?如果使用一特殊结构,请指明使用原因或优于其它结构的方面。 ?在选择一个有效的结构时,要考虑以下几个方面: -- 在目标上执行的操作类型 -- 访问目标的类型和频度 -- 结构的有效性 4功能模块详细描述 首先请简要介绍模块的目的。可以用以下格式描述功能模块的详细设计: ?模块名称 ?主要功能描述 ?模块的输入参数的名称、数据类型、顺序位置、格式等 ?模块的输出参数的名称、数据类型、顺序位置、格式,以及错误标记等 ?过程和功能调用 ?数据引用(全局,本地,结构) ?模块的处理流程(采用流程图、判定表辅以必要的说明来表示逻辑流程) ?模块的界面设计(可以采用图片和表格的形式,具体内容包括:界面格式;界面要素的位置、类型和特殊约定;操作及步骤等必要的说明) ?接口(用图的形式说明本程序所隶属的上一层模块及隶属本模块的下一层模块,说明参数赋值和调用方式,说明与本程序直接关联的数据结构) ?限制条件(说明本模块运行所受到的限制条件) ?伪代码 5需求以及设计跟踪表

超市管理系统详细设计说明书讲解学习

超市管理系统详细设 计说明书

超市管理系统详细设计说明书 1引言 1.1编写目的 为了提高物资管理的水平和工作效率,尽可能杜绝商品流通中各环节中可能出现的资金流失不明现象,商品进销存领域迫切需要引入信息系统来加以管理。从该阶段开发正式进入软件的实际开发阶段,本阶段完成系统的大致设计并明确系统的数据结构与软件结构。在软件设计阶段主要是把一个软件需求转化为软件表示的过程,这种表示只是描绘出软件的总的概貌。本概要设计说明书的目的就是进一步细化软件设计阶段得出的软件总体概貌,把它加工成在程序细节上非常接近于源程序的软件表示。 预期读者为超市管理系统的开发人员,程序员。 1.2背景 项目名称:超市管理系统。 提出者:XXX。 开发者:郭琦,梁颖嘉,刘浩然,李小龙。 用户:中小型超市 1.3定义 XXXX(列出本文件中用到的专门术语的定义和外文首字母组词的原词组。)

1.4参考资料 软件设计文档国家标准操作手册(GB8567——88)。 2程序系统的结构 见《超市管理系统概要设计说明书》相关部分。 3售货管理子系统设计说明 3.1 程序描述 超市管理系统下的一个子系统,记录售货员今日处理的商品信息和会员的购买情况,处理销售过程中的商品信息并作记录。 3.2 功能 包括售货员登陆和会员登陆,以及售货员的售货处理、结账处理。3.3 性能 时间特殊性:系统的速度要在用户可接受的范围内。 可靠性:系统要有较高的可靠性,可恢复性。 灵活性:系统要有良好的接口。 3.4 输入项 售货员账号密码:售货员登陆 会员账号:会员登陆

条形码:验证商品信息 数量:计算金额 3.5 输出项 售货员信息:确保售货员符合资格会员信息:确保会员符合资格 金额:结账时的商品总额 3.6算法 start input售货员信息 examine 售货员信息 input 会员信息 examine 会员信息 if(结账) input i=0 do while (i<商品数量) input 条形码 if(条形码无效) i=i break end if print 商品信息 i=i+1

详细设计说明书(模板)

东软机密 文件编号:D05-PDT073 详细设计说明书模板 版本:0.0.0-1.2.0 2009-6-30 东软集团股份有限公司软件开发事业部 (版权所有,翻版必究)

文件修改控制 修改编号版本修改条款及内容修改日期 1 0.0.0-1.1.0修改LOGO 2005-7-29 2 0.0.0-1.1.1 1、修改公司标识为“东软集团股份有限公司”。 2、修改文件密级标识为“东软机密”。 2008-8-25 3、将“单体测试”改为“单元测试” 3 0.0.0-1.2.0 根据公司要求,转换为OpenOffice格式2009-06-17

东软机密 文件编号:项目编号DDR顺序号第版分册名称:第册/共册 项目名称(项目编号) 详细设计说明书 (软件开发事业部) 东软集团股份有限公司 总页数正文附录生效日期 编制批准

修改记录 版本号变更控制报告 编号 更改条款及内容更改人审批人更改日期

目录 1引言 (1) 1.1 目的 (1) 1.2 背景 (1) 1.3 词汇表 (1) 1.4 参考资料 (1) 2系统结构 (1) 2.1 需求概述 (1) 2.2 总体设计 (2) 3.系统详细设计说明 (2) 3.1 包及类结构设计 (2) 3.2 模块设计 (2) 3.3 Message文件管理Module (2) 3.4 LOG管理Module (2) 3.5 配置文件管理Module (2) 3.6 异常模块说明 (3) 4.其他设计要求 (3) 4.1 单元测试 (3) 4.2 注释及代码风格 (3) 4.3 尚未解决问题 (3) 5附件说明 (3)

详细设计说明书 真正例子

详细设计说明书 1.引言 1.1编写目的 本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详细设计,在概要设计的基础上进一步明确系统结构,详细地介绍系统的各个模块,为进行后面的实现和测试作准备。本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣,在以后想对系统进行扩展和维护的人员。 2.系统的结构 ●ui:系统界面部分,负责接受用户输入,显示系统输出,负责其他模块功能的协调调用, 并含有站内搜索功能,即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui 部分调用common部分的功能读取xml文件中保存的界面元素属性信息,用户最近访问过的10个ftp信息,用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。 ●client:实现ftp客户端的功能,ftp连接,ftp上传及下载:上传或下载用户指定的

资源,并返回相应的信息。 ●search:资源实时检索部分,根据用户输入的资源名称关键字,资源类型和选择的检索 方式检索用户需要的资源,并验证资源的可用性,返回可用资源及其大小,速度等相关信息。 ●preview:资源预览部分,显示用户选择的资源的部分内容,以使用户决定是否需要该 资源。preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式。 3.模块1(ui)设计说明 3.1模块描述 实现用户界面的包,含有11个文件51个类,是本系统中最复杂的代码。 3.2功能 负责接受用户输入,显示系统输出,其他模块功能的协调调用,并含有站内搜索功能,即在用户指定的已打开的ftp站点中搜索用户需要的资源。 3.3交互的模块 client,search,preview,common。 3.4模块设计 该模块中的主要文件,文件中包含的主要类及其功能和与其它包的交互如下: ●MainFrame.java:MainFrame是含有主函数的类,也是lyra客户端开始执行的类, 它先后进行资源的初始化,显示主界面等工作,根据屏幕大小设置界面大小,设置界面的观感。 ●FtpFrame_AboutBox.java:显示关于窗口的类,当用户点击帮助菜单中的关于菜单 项时会弹出关于对话框。 ●Tools.java:FileTools是文件操作辅助类,可以实现文件的递归删除等。 ●XMLController.java:JDOMTes是操作xml文件的类,用JDOM来操作xml文件, 实现的功能有: (1)保存ftp服务器的文件列表(站内搜索时使用),递归的从ftp服务器读取列表,并存入一个xml文件中(文件的命名方法是:ip+用户名.xml);以目录树的形式保存。 (2)根据文件名在文件中查找文件,站内搜索时使用。 (3)保存ftp服务器的信息:ip,端口(默认端口21不保存),用户名(默认anonymous 不保存),密码,最多存10个;存在resource\settings\serversinfor.xml文件中。 (4)读取已存储的ftp服务器信息。 (5)从type.xml读取搜索的类型。 ●Constants.java:放置系统运行时使用的一些常量,initcontent()函数对所有常量进行 初始化,这个函数在MainFrame中被调用一次。iconHashMap是hash表,用于存放文件的系统图标。 ●CustomizedController.java:包含自定义的控件类,java中的控件可能不能满足需求, 需要自己定义某些属性。这些控件会在创建界面时使用。其中含有的类有: (1)CustomizedJTable是表格类,设置表格的某些属性,如字体等。 (2)CustomizedTableCellRenderer是表格单元格绘制器类,主要用于显示文件的系统图标,和文件名。 (3)LeftPanel类的父类是JTabbedPane,用户显示主窗口左边的面板。

相关主题
文本预览
相关文档 最新文档