详细设计说明书 真正例子

详细设计说明书

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，用户显示主窗口左边的面板。

（4）RightPanel类的父类是JPanel，用户显示右边的主题部分，包括右上边的搜索及服务

器选项，和中间的显示服务器文件的TabbedPane。.

（5）BottomPanel类是右下放显示下载和服务器信息的JTabbedPane。

（6）CustomizedJButton 是定义按钮类，更改了按钮的字体，java本身默认的字体不好看。（7）CustomizedTableModel是表格类，实现单元格的不可编辑。

（8）CustomizedTableCellRenderer_Remote类是表格绘制器，在远程文件浏览器RemoteFilesPanel使用，用于显示文件名和文件图标。

（9）FontTableCellRenderer类是表格单元格绘制器，主要功能是设置字体。

（10）FontListCellRenderer类是下拉列表框单元格绘制器，主要用于设置字体。

（11）CustomizedJLabel类是自定义标签类，重新设置了标签的字体。

（12）CustomizedJTextField类是自定义文本框类，主要用于设置文本框的显示属性。（13）CustomizedJMenu类是自定义菜单类，重新设置了菜单的字体。

（14）CustomizedJMenuItem类是自定义菜单项类，重新设置了菜单的字体。

（15）CustomizedListCellRenderer类是JComboBox即组合框单元格绘制器，用于在本地路径选择的下拉列表中显示磁盘图标。

●SearchResultReceiver.java, SearchResultReceiver是一个接口，主要用于返回搜索结果。

搜索完成后调用接口中的函数通知调用者。其中主要有两个函数：

（1）OnSearchFinished(String[] keywords,ArrayList[] resultset);result是一个10维的数组表result[10],result[i]是由类型为i的资源组成的数组。i：0－9，和类型列表框中的顺序一致。（2）OnSearchFinished(String[] keywords,ArrayList resultset);不分类型，将所有资源放在一个数组表中。

●FtpFrame.java:FtpFrame是程序主窗口类，类型为JFrame,是由三个分割窗口JSplitPane

构成的。

jSplitPane_Left是左边的分割窗口，水平分割条上边显示本地文件框，下边是预览框；jSplitPane_Right是右边的分割窗口，水平分割条上边是服务器选项和ftp服务器文件显示的窗口，下边是下载和服务器信息显示窗口；

jSplitPane_Whole是整体的分割窗口，垂直分割条，左边是jSplitPane_Lef，右边是jSplitPane_Right。

FtpFrame把LeftPanel，RightPanel，BottomPanel，PreviewWrapperPanel这几部分安装在相应的分割窗格中；LeftPanel，RightPanel，BottomPanel是在CustomizedController.Java中定义的，PreviewWrapperPanel是在Preview包中定义的。

●LeftPanelCtrl.java: LocalFilesPanel是本地文件面板，用表格来显示本地文件的信

息。上边是组合框，显示了磁盘分区通过这里可以改变根目录。表格中显示了文件的信息，包括文件名，文件的系统图标，大小，最近修改日期，属性等。选中一个文件后可以执行上载和删除操作。文件夹会递归的删除。GetCurrentPath（）函数返回当前的路径。DisplayPathFiles（）函数在列表中显示指定目录下的文件。

●RightPanlCtrl.java：定义右上边的控件。含有的类有：

（1）FtpServerOptionPanel类是服务器连接选项面板，包含服务器地址，端口，用户名，密码等，还包括最上端的搜索选项。openRemoteFilesPanel（）函数在下面的TabbedPane中打开一个新的服务器面板，连接服务器。

（2）RemoteFilesPanel类的主要功能是连接Ftp服务器并显示文件。这里会进行文件的上载，下载及预览等操作。RemoteFilesPanel 的内部类TransferController负责调用FtpClient类提供的功能与服务器进行交互，完成用户指定的文件操作。TransferController还有三个内部类：ConnThread类是负责连接服务器的线程（新开一个线程，目的是避免连接时阻塞），DownloadFileThread类是下载文件的线程，UploadFileThread类是上载文件的线程。

（3）SearchResultPanel类是显示搜索结果的类，它有两个子类SearchResultPanelWithinSearchEngine类的功能是在搜索引擎中搜索，SearchResultPanelWithinServer类的功能是站内搜索。搜索引擎的搜索会调用search包中的程序，搜索引擎搜索完成后search包通过OnSearchFinished（）来通知SearchResultPanelWithinSearchEngine类，然后显示搜索结果。

（4）RightTabbedPane是显示ftp服务器文件表格的TabbedPane类。

BottomPanelCtrl.java：实现主窗口下部面板及控件，显示下载情况，服务器连接信息。

包含的主要类有：

（1）RemoteMessPanel类是显示服务器连接信息的面板。需要显示ftp服务器传回的信息，并在显示前进行编码转换，还需要显示本地的相关信息。

（2）DownloadingMessPanel类是显示资源下载信息的面板，显示下载资源的大小，下载速度，已用时间，剩余时间等信息。

3.5流程逻辑

总体流程：

4．模块2（client）设计说明

4.1模块描述

实现ftp客户端FtpClient，有两个文件FtpClient.java和FtpLoginException.java,前者具体实现了ftp协议，后者是为登录时可能抛出的异常而定义的类。

4.2功能

实现ftp客户端FtpClient，实现了ftp协议，用于和ftp服务器通讯和数据传输。4.3交互的模块

ui

4.4 模块设计

该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下：

FtpClient.java：含有类FtpClient,，该类会被ui包中的界面类调用，完成ftp功能。

其中要功能的实现有：

在构造函数中根据ip和port建立与服务器的连接；

登录服务器login（）（用户名，密码）；

向服务器追加ascii文件appendAscii（）；

向服务器追加二进制文件appendBinary（）；

设置数据传输方式为二进制binary，ascii码scii（）；

改变工作目录cd（String newdirectory）；

返回上一级目录cdup（）；

断开连接closeserver（）；

删除文件delete（文件名）；

删除文件夹rmdir（文件夹的名字）；

用ascii模式下载文件getAscii（文件名）；

用二进制方式下载文件getBinary（文件名）；

取得服务器的响应字串getResponseString()；

列举当前目录下的文件list（），指定目录下的文件list（文件名）；

创建文件夹mkdir（文件夹名）；

上载Ascii文件putAscii(文件路径)，二进制putBinary（）。

●FtpLoginException.java：含有类FtpLoginException，定义登录时可能抛出的异常。5．模块3（common）设计说明

5.1模块描述

存放一些辅助类，系统启动时会从properties.xml读取一些配置信息。可以通过手动修改配置信息来修改系统的某些显示属性如字体，字的大小等。

5.2功能

存放一些辅助类，例如用于读取和存储系统配置属性的类。用于将“属性名－属性值”对存储在properties.xml文件中的类。

5.3交互的模块

ui

5.4 模块设计

该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下：

●Properties.java:含有类Properties，这是读取和存储系统配置属性的类。其主要功

能的实现如下：

函数getProperty（）根据属性名取得属性值，如果属性不存在返回null；

函数getProperties（）根据属性名列表返回属性值列表，返回值为ArrayList，其中的每一个元素是PropertyValue对象；

函数setProperty（）设置单个属性值；

函数setProperties（）设置多个属性值；

函数readXMLFromFile（）读取xml文件；

函数buildXML（）在xml文档中存入数据；

●PropertyValue.java：含有类PropertyValue，在xml文件中存储“属性名－属性值”

对。

6．模块4（search）设计说明

6.1模块描述

包search主要完成天网和百度两项搜索功能。它含有以下6个类：NetResource，URLParser，ConnectionTester，SearchResultRetriever，EmbeddedFileRetriever，HttpRetriever。

6.2功能

主要完成天网和百度两项搜索功能。

6.3交互的模块

ui

6.4 模块设计

该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下：

●NetResource.java：含有类NetResource，NetResource是对被天网索引的网络文件资源

的抽象，其字段有：fileURL（文件资源的URL，包括协议、主机字符串、路径、文件名）、fileDate（天网将它编入索引的日期）、fileSize（文件的大小）、responseTime（以毫秒计算的响应时间）。

函数smallerThan(NetResource nr)比较本条资源的响应时间是否比nr的响应时间小，因为规定响应时间小的NetResource排在相应时间大的前面。

●URLParser.java：含有类URLParser，URLParser是一个工具箱类，它提供了若干静态方

法，对一个文件资源的URL进行解析。其实现的方法有：

函数getProtocol（）：给定一个URL，返回其协议名称；

函数getHostName（）：给定一个URL，返回主机字符串;

函数getPath（）：给定一个URL，返回文件在主机中的存放路径;

函数getFileName（）：给定一个URL，返回文件名;

函数getSuffix（）：给定一个URL，返回该URL对应的文件资源的后缀名。

●ConnectionTester.java：含有类ConnectionTester，ConnectionTester是用来对网络文件

资源进行连接测试的类，它实现了Runnable接口。SearchResultRetriever类将ConnectionTester类作为模板生成许多线程并发地对各文件资源进行连接并测试相应时间，以提高程序效率。每个网络文件都是用NetResource类表示的。对于ftp文件，ConnectionTester尝试以匿名方式连接。如果连接失败则丢弃该资源的URL，若连接成功则根据连接它响应时间将其插入已排序的NetResource列表中。对于http文件，ConnectionTester建立一个新的URLConnection，并调用connect方法尝试连接。如果连接失败则丢弃该资源的URL，若连接成功则根据连接它的响应时间将其插入已排序的NetResource列表中。在构造ConnectionTester类的对象时必须指定一个由NetResource 类的对象组成的ArrayList，其中每个NetResource都需要测速。

该类的功能主要由函数run()实现。

●SearchResultRetriever.java：含有类SearchResultRetriever，SearchResultRetriever类根

据给定的关键字和文件类型向天网文件搜索引擎发送请求，对各返回结果页面的源文件进行分析，将所有网络文件资源的URL进行分类（利用天网的分类方法）并保存在10个ArrayList中。该类的函数如下：

函数test（）判断这个"下一页"对应的URL是否合法，该问题仅在用程序访问天网时需要考虑

函数retrieve（）根据输入的关键字String[] tokens向天网发出请求，取得返回的URL 集合，ArrayList0保存图片－imagefile；ArrayList1保存音乐－soundfile；ArrayList2保

存电影－videofile；ArrayList3保存压缩－zipfile；ArrayList4保存文档－docfile；

ArrayList5保存程序－programfile；ArrayList6保存源码－srcfile；ArrayList7保存网页－webfile；ArrayList8保存目录－dirfile；ArrayList9保存其他－file。对每一个ArrayList 生成若干ConnectionTester线程进行响应时间测试，在这些线程返回后每一个ArrayList 中的网络文件资源都已经按照响应时间递增的顺序排列，而无法连接的文件资源URL 都已被丢弃。SearchResultRetriever类的使用方式是调用它的函数retrieve（String[] tokens, int type），其中tokens为表示关键字的字符串数组；type表明用户需要搜索什么类型的文件。该方法将上述10个ArrayList组成一个数组并返回。

●EmbeddedFileRetriever.java：含有类EmbeddedFileRetriever，EmbeddedFileRetriever

类的作用是提取网页中文件链接，它实现了Runnable接口。HttpRetriever类将EmbeddedFileRetriever类作为模板生成若干线程并发地提取不同网页内的文件链接，以提高程序效率。EmbeddedFileRetriever类维护了一个网页后缀名列表，由于程序只提取对应文件资源的URL，我们需要分辨哪些后缀名是对应网页的从而及时将它们丢弃。

在构造类EmbeddedFileRetriever的对象时必须指明从哪个网页URL中提取文件URL，以及这些URL保存在哪个ArrayList中。

函数hasFileSuffix（）的功能是判断一个url是否链向一个文件；

函数listFiles(String URLStr)将URLStr对应页面中的所有文件加到ArrayList中并返回。

●HttpRetriever.java：含有类HttpRetriever，HttpRetriever类的功能是根据给定的关键字

向百度搜索引擎发送请求，抽取前20个返回结果对应的网页URL。对每一个页面生成一个EmbeddedFileRetriever对象提取其中对文件的链接，并添加到一个ArrayList中。

每个页面都处理完毕后返回这个ArrayList。在利用搜索文件时，应当提供尽可能多的信息，如输入歌手姓名和“mp3”作为关键字。如果仅给定歌手名称则搜索效果不佳。

这些功能都是由函数retrieve（）实现的。

6.5类图

7．模块5（preview）设计说明

7.1模块描述

系统的预览部分，实现了不同类型资源的预览，并可以根据用户选择的格式显示资源的内容。

7.2功能

各种类型资源的预览，可以根据用户的选择格式显示资源的内容，并可以存储用户选择的预览内容。

7.3交互的模块

ui

7.4 模块设计

该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下：

●PreviewWrapperPanel.java:含有类PreviewWrapperPanel，这是系统的预览

部分最基本的类，它派生自Jpanel类，主要由3部分组成，其中PreviewPanel 负责显示预览，StatusBarPanel负责显示预览文件的加载进度，

ControlButtonPanel负责和预览相关的控制。在显示资源的预览内容前应该先判断该资源类型是否可以预览。

●PreviewPanel.java：含有类PreviewPanel，这是一个抽象类，负责资源内

容的预览，有5个子类，这5个子类分别是

PicturePreviewPanel类：负责图像文件的预览；

PDFPreviewPanel类：负责PDF文件的预览；

TxtPreviewPanel类：负责文本文件的预览；

NoFileSelectedPreviewPanel类：负责当用户没有选项文件预览时显示提示信息；

NoPreviewPanel类：负责当用户选择的文件不能预览时，显示提示信息。

PreviewPanel类实现的主要功能是构造预览窗口的实例，有两种构造方式：以默认大小构造或以指定大小构造。

PreviewPanel类的函数preview()是一个虚函数，系统可以根据不同的子类调用不同的预览函数。

●PicturePreviewPanel.java:含有类PicturePreviewPanel，它的主要功能是

图像文件的预览，其中有4个内部类，分别是：

ImagePanel类：这是显示图像的JPanel，主要功能是绘图；

PopupListener类：用户单击右键弹出菜单的类，右键功能是设置图像的显示是“适合窗口”还是“原始大小”；

picPopupMenuListener类：负责对右键菜单中事件的响应。

PictureFromDiskLoader类：负责从磁盘上加载图像文件。

●TxtPreviewPanel.java: 含有类TxtPreviewPanel，它的主要功能是文本文

件的预览，其中有5个内部类，分别是：

PopupListener类：用户单击右键弹出菜单的类，

txtPopupMenuListener类：负责对右键菜单中事件的响应；

FileFromDiskLoader类：负责从磁盘加载文本文件；

FontChooseDialog类：字体选择对话框；

FontDialogEditorMediator类：负责对话框选择的字体和预览区域显示的字体之间的更新。

●PDFPreviewPanel.java：含有类PDFPreviewPanel,该类使用第三方的软件包

JPedal来实现pdf文件的预览。

●ControlButtonPanel.java:含有类ControlButtonPanel，该类的功能是根据

用户的选择保存预览资源，即把预览的文件存放到用户选定的目录。他的功能主要由两个内部类来实现，分别是：

saveAction类：实现了接口ActionListener，是对预览资源保存按钮的响应，实现预览资源保存功能，把预览的文件存放到用户选定的目录。

ExampleFileFilter类：继承自类FileFilter，实现用户选择文件保存目录的功能，即弹出文件选择对话框。

7.5类图

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

软件详细设计说明书 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公共数据结构 〖给出本软件系统使用的每一个公共数据结构的类型定义、存储方式，公共数据结构内各元素项的类型定义、初始取值、可能取值的范围及相应的物理含义。建议以类似Ｃ语言的数据说明格式来描述。〗

综合课程设计方案

Y082231本科（自考）综合课程设计 任务书指导书 西南交通大学 远程与继续教育学院 2017年10月

目录 一、综合课程设计的意义、目标和程序 二、综合课程设计内容及要求 三、综合课程设计成果及格式要求 四、设计方法和要求 五、综合课程设计答辩要求及成绩评定附件1：综合课程设计成果格式

一、综合课程设计的意义、目标和程序 （一）综合课程设计的意义 综合课程设计是工程造价专业人才培养计划的重要组成部分，是实现培养目标的重要教学环节，是人才培养质量的重要体现。根据工程造价专业（独立本科段）考试计划的要求，通过综合 课程设计，可以培养考生用所学基础课及专业课知识和相关技能，解决具体的工程造价实际问题 的综合能力。本次综合课程设计要求考生在指导教师的指导下，独立地完成单项工程的造价的编制，解决与之相关的问题，熟悉定额、手册、标准图以及工程实践中常用的方法，具有实践性、综合性强的显著特点。因而对培养考生的综合素质、增强工程意识和创新能力具有其他教学环节 无法代替的重要作用。 综合课程设计是考生在课程学习结束后的实践性教学环节；是学习、深化、拓宽、综合所学 知识的重要过程；是考生学习、研究与实践成果的全面总结；是考生综合素质与工程实践能力培 养效果的全面检验；是考生毕业及学位资格认定的重要依据；也是衡量高等教育质量和办学效益 的重要评价内容。 （二）综合课程设计的目标 综合课程设计基本教学目标是培养考生综合运用所学知识和技能，分析与解决工程实际问题，在实践中实现知识与能力的深化与升华，初步形成经济、环境、市场、管理等大工程意识，培养考生严肃认真的科学态度和严谨求实的工作作风。使考生通过综合课程设计在具备工程师素质方面更快地得到提高。根据高等教育自学考试工程造价（独立本科段）专业的培养目标，对综合课程设计有以下几方面的要求: 1.主要任务 本次任务在教师指导下，独立完成给定的设计任务，考生在完成任务后应编写出符合要求的设计说明书、提交综合课程设计计算书。 2.专业知识 考生应在综合课程设计工作中，综合运用各种学科的理论知识与技能，分析和解决工程实际问题。通过学习、研究和实践，使理论深化、知识拓宽、专业技能提高。 3.工作能力 考生应学会依据综合课程设计课题任务进行资料搜集、调查研究、方案论证、掌握有关工程设计程序、方法和技术规范。提高理论分析、言语表达、撰写技术文件以及独立解决专题问题等能力。

需求分析说明书、详细设计说明书、概要设计说明书样例

以下是需求分析说明书、详细设计说明书、概要设计说明书样例 需要详细资料的去 https://www.wendangku.net/doc/1f8923538.html,/BBS/view.asp?ID={CA9329C0-93C5-4417-9170-452FF61E8C DB}&page=1下载 XX系统概要设计说明书 目录 1. 文档介绍1 1.1 文档目的1 1.2 文档范围1 1.3 读者对象1 1.4 参考文献1 1.5 术语与缩写解释1 2. 系统概述2 3. 设计约束2 3.1需求约束2 3.2隐含约束2 4. 设计策略3 4.1扩展策略3

4.2复用策略3 4.3折衷策略3 5．系统总体结构3 5.1、系统总体结构3 5.2、子系统功能及接口4 6. 子系统的结构与功能5 6.1、TERMSERV 5 7. 功能需求追溯5 8. 环境的配置5 9．其它6 附录 6 A、与主机接口6 B、与终端接口6 1. 文档介绍 1.1 文档目的 编写该文档的目的在于从总体设计的角度明确xxxx系统的功能和处理模式，明确与银联的接口，使系

统开发人员和产品管理人员明确产品功能，可以有针对性的进行系统开发、测试、验收等各方面的工作。 1.2 文档范围 1.3 读者对象 该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。 1.4 参考文献 《xxxx系统需求说明书》 1.5 术语与缩写解释 无 2. 系统概述 XX系统是以触摸屏为主要交互工具，帮助用户以自助方式做业务查询。本系统的主要功能包括：话费 查询、新业务介绍、网点分布查询、自助终端分布查询、电信新闻、交易监控、设备维护和监控等。本系 统的设计目标是保证系统可以7*24小时安全、高效无故障运行；业务人员可以轻松完成设备和交易的监控 、管理工作；报表种类齐全，可以满足业务人员各种帐务需求。 3. 设计约束

完整版详细设计说明书实例

信息发布系统 （详细设计说明书） JAVA 实践小学期第22组 1.0 2010/9/5 编写单位： 设计人员： 版 本: 编写日期：

目录 第一部分、引言 (2) 1.1编写目的 (2) 1.2背景 (3) 1.3定义 (3) 3.1程序描述 (5) 3.2整体结构 (5) 3.3性能 (5) 3.4输入输出项 (5) 3.5算法 (5) 3.6主要类的设计 (5) 3.7存储分配 (7) 3.8注释 (7) 3.9限制条件 (7) 3.10测试计划 (7) 3.11尚未解决的问题 (7) 4.1程序描述 (7) 4.2功能 (7) 4.3性能 (8) 4.4输入输出项 (8) 4.5限制条件 (8) 5设计特点 (8) 5.1通信便捷 (8) 5.2开发速度快 (8) 第六部分、项目分工 (8) 附录： (9) 第一部分、引言 1.1编写目的 本说明书在概要设计的基础上，对信息发布系统的各模块、程序分别进行了实现层面上的要 求和说明。 软件开发小组的产品实现成员应该阅读和参考本说明进行代码的编写、测试。

1.2背景 说明: A、软件系统的名称：信息发布系统 B、任务提出者：JAVA实践小学期开发者：第22组成员 C、实现完成的系统将可用在所有JAVA虚拟机的个人PC上.为使用者提供信息发布，浏 览，评论的方式，沟通各个用户? 1.3定义 服务器端API :服务器端设计者通过规范的API文档，提供给客户端，以方便客户端的开 发，使得同时进行，提高效率，节约时间。两端通过protocol （协议类）进行通信。 Gson：Google提供的一个类库。通过使用这个类库，可以把把对象转换成json格式的字符串，以方便在网络中的传输。也可反向将字符串转换成对象，这样带有方法地操作对象，可以有效，方便地保证信 息的沟通。 Json： JavaScript Object Notation，是一种轻量级的数据交换格式。易于人阅读和编写，同时也易于机器解析和生成。它基于JavaScript的一个子集，JSON采用完全独立于语言的文本格式， 这些特性使得JSON成为理想的数据交换语言。 1.4参考资料，相关的文件包括： A、《项目需求说明》； B、《项目详细设计说明书》； C、《项目概要设计说明书》；参考资料： 《软件工程概论》，王华 第二部分、程序系统的结构 该系统为了两大部分：客户端与服务器端，中间通过protocol类通信。其中使用gson库来转换和逆向转换对象，实现标准包括： 1、客户端主程序 A、工程类型：JAVA项目； B、工程名称：信息发布系统 C、编译生成文件：jar形式 D、引用的组件：JDK，Gson库 注：以上提供的是工具集合，具体用到的类都包含在里面 2、服务器端主程序： 服务器端程序以及数据库操作类（DBO） 3、服务器端数据库操作 验证用户，用户注册，更改密码，更新文档，新建文档，新建记录（包括浏览记录和回复记录），查看文档，删除文档，查看记录。

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

详细设计说明书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:界面名称〉 ................................ 错误!未定义书签。

需求分析说明书、概要设计说明书、详细设计说明书部分样例.doc

需求分析说明书、概要设计说明书、详细设计说明书部分样例 作者：rjgczj 出处：csai论坛 以下是需求分析说明书、详细设计说明书、概要设计说明书样例，需要的朋友来信联系。rjgczj@ For personal use only in study and research; not for commercial use XX系统概要设计说明书 目录 1. 文档介绍1 1.1 文档目的1 1.2 文档范围1 1.3 读者对象1 1.4 参考文献1 1.5 术语与缩写解释1 2. 系统概述2 3. 设计约束2 3.1需求约束2 3.2隐含约束2 4. 设计策略3 4.1扩展策略3 4.2复用策略3 4.3折衷策略3 5．系统总体结构3 5.1、系统总体结构3

5.2、子系统功能及接口4 6. 子系统的结构与功能5 6.1、TERMSERV 5 7. 功能需求追溯5 8. 环境的配置5 9．其它6 附录 6 A、与主机接口6 B、与终端接口6 1. 文档介绍 1.1 文档目的 编写该文档的目的在于从总体设计的角度明确xxxx系统的功能和处理模式，明确与银联的接口，使系统开发人员和产品管理人员明确产品功能，可以有针对性的进行系统开发、测试、验收等各方面的工作。 1.2 文档范围 1.3 读者对象 该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。 1.4 参考文献 《xxxx系统需求说明书》 1.5 术语与缩写解释 无 2. 系统概述 XX系统是以触摸屏为主要交互工具，帮助用户以自助方式做业务查询。本系统的主要功能包括：话费查询、新业务介绍、网点分布查询、自助终端分布查询、电信新闻、交易监控、设备维护和监控等。本系统的设计目标是保证系统可以7*24小时安全、高效无故障运行；业务人员可以轻松完成设备和交易的监控、管理工作；报表种类齐全，可以满足业务人员各种帐务需求。

详细设计说明书书真正例子

详细设计说明书 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，用户显示主窗口左边的面板。 （4）RightPanel类的父类是JPanel，用户显示右边的主题部分，包括右上边的搜索及服务

详细设计说明书模版

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

文件修改记录 修改日期版本号变化状态修改内容修改人 *变化状态：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)

机电一体化系统综合课程设计说明书

机电一体化系统课程设计 X-Y数控工作台设计说明书 学校名称：湖北文理学院 班级学号：2013279129 学生姓名：张亮 班级：机电1321 2015年11月

一、总体方案设计 1.1 设计任务 设计一个数控X-Y工作台及其控制系统。该工作台可用于铣床上坐标孔的加工和腊摸、塑料、铝合金零件的二维曲线加工，重复定位精度为±0.01mm，定位精度为0.025mm。 设计参数如下：负载重量G=150N；台面尺寸C×B×H＝145mm ×160mm×12mm；底座外形尺寸C1×B1×H1＝210mm×220mm×140mm；最大长度L=388mm；工作台加工范围X=55mm，Y=50mm；工作台最大快移速度为1m/min。 1.2 总体方案确定 （1）系统的运动方式及伺服系统 由于工件在移动的过程中没有进行切削，故应用点位控制系统。定位方式采用增量坐标控制。为了简化结构，降低成本，采用步进电机开环伺服系统驱动X-Y工作台。 （2）计算机系统 本设计采用了及MCS-51系列兼容的AT89S51单片机控制系统。它的主要特点是集成度高，可靠性好，功能强，速度快，有较高的性价比。 控制系统由微机部分、键盘、LED、I/O接口、光电偶合电路、步进电机、电磁铁功率放大器电路等组成。系统的加工程序和控制命令通过键盘操作实现。LED显示数控工作台的状态。

（3）X-Y工作台的传动方式 为保证一定的传动精度和平稳性，又要求结构紧凑，所以选用丝杠螺母传动副。为提高传动刚度和消除间隙，采用预加负荷的结构。 由于工作台的运动载荷不大，因此采用有预加载荷的双V形滚珠导轨。采用滚珠导轨可减少两个相对运动面的动、静摩擦系数之差，从而提高运动平稳性，减小振动。 考虑电机步距角和丝杆导程只能按标准选取，为达到分辨率的要求，需采用齿轮降速传动。 图1-1 系统总体框图

详细设计说明书大纲

详细设计说明书大纲 1 引言 1.1 编写目的 说明编写这份详细设计说明书的目的，指出预期的读者。 1.2 背景 ●用一个名字标识被生产的软件产品； ●列出此项目的任务提出者、开发者、用户。 1.3 定义、缩写词、略语 本条中必须提供全部需求的术语、缩写词及略语的定义，也可以参考其他的文件。 1.4 参考资料 列出有关的参考文件，如： ●本项目的经核准的计划任务书，上级机关批文、合同等； ●属于本项目的其他已发表文件； ●本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 程序系统的结构 用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。 3 程序1设计说明 从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单说明这一点即可。

3.1 程序描述 给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如是常驻内存还是非常驻？是否子程序？是可重入的还是不可重入的？有无覆盖要求？是顺序处理还是并发处理？等）。 3.2 功能 说明该程序应具有的功能。 3.3 性能 说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。3.4 输入项 给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等等。 3.5 输出项 给出对每一个输出项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输出的形式、数量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等等。 3.6 算法 详细说明本程序所选用的算法，具体的计算公式和计算步骤。 3.7 流程逻辑 用图表辅以必要的说明来表示本程序的逻辑流程。 3.8 接口 用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。

软件综合课程设计教学大纲

珠海学院课程教学大纲 课程名称：计算机软件综合课程设计 适用专业： 2015级软件工程专业 课程类别：专业基础课 制订时间：2017年6月 计算机科学与技术系制

目录 1 《计算机软件综合课程设计》教学大纲 2 《计算机软件综合课程设计》（模板） 3 《计算机软件综合课程设计》成绩评定表

《计算机软件综合课程设计》教学大纲 一、课程设计基本信息 课程代码： 课程名称：计算机综合应用课程设计 课程学时：32学时 课程学分：2.0 适用对象：计算机科学与技术专业、软件工程专业 先修课程：高级语言程序设计、数据结构、操作系统、数据库原理与应用 二、课程设计目的和任务 本课程设计是检验计算机专业的学生在大学主干课程完成之后，为了加深和巩固学生对前两年所学理论和应用知识的理解，同时提高学生综合运用的能力和分析问题、解决的问题的能力而开设的一门实践课程。 通过本环节学生能够充分把前两年学到的知识综合应用到实际的编程实践中，可以进一步巩固所学到的理论。通过实现一个中等规模的应用软件，提高利用计算机系统解决实际问题的能力，为顺利毕业、进入社会打好基础；通过对程序的规范编写，可以培养学生良好的编程风格，包括程序结构形式，行文格式和程序正文格式等；并培养学生的上机调试能力。 三、课程设计方式 1、课程设计题目的选定 采用指导教师提供参考题目与学生自主命题相结合的办法选定课程设计题目。要求不多于4个人一个小组，不得重复，所涉及数据库的基本表至少在5张表以上，在尽量满足数据库设计原则的前提下，允许适当冗余以提高检索的速度。其中学生自主命题需要指导教师严格的审核，看是否满足课程要求，检查是否为重复课题。 2、课程设计任务的完成

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

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)

车辆工程综合课程设计说明书

课程设计任务书 课程车辆工程综合课程设计 题目某轿车前轮制动器主要零件设计（蹄或钳及轮缸部分）——1 专业车辆工程姓名学号 主要内容及基本要求： 已知条件：总质量为2200kg；前轴负荷率为35%；质心高度为1m；轴距为3.05m。轮胎型号：225/60R16。制动性能要求：初速度为50km/h，制动距离为15m. 在以上条件下，完成制动器主要基本参数的选择、确定（与后轮制动器设计的同学共同完成）；完成制动器主要零件的设计计算；完成前轮制动器主要零件设计的设计图纸。 工程图纸须规范化，计算说明书须用国际单位制量纲。 参考资料： [1]王望予.汽车设计（第4版）.北京：机械工业出版社,2004 [2]王国权,龚国庆.汽车设计课程设计指导书.北京：机械工业出版社,2009 [3]王丰元,马明星.汽车设计课程设计指导书.北京：中国电力出版社,2009 [4]陈家瑞.汽车构造（第3版下册）.北京：机械工业出版社,2009 [5]余志生.汽车理论（第5版）.北京：机械工业出版社,2009 [6]张海青.耐高温的盘式制动片.非金属矿.2008

完成期限 2017.8.28至2017.9.22 指导教师 专业负责人 2014年 9月 18 日 目录 1设计要求 0 2制动器形式方案分析与选择 0 2.1鼓式制动器 0 2.2盘式制动器 (2) 3前轮制动器设计计算 (6) 3.1制动系统主要参数数值 (6) 3.1.1相关的汽车主要参数 (6) 汽车主要参数如表3-1所示。 (7) 表3-1 汽车相关参数 (7) 3.1.2同步附着系数的分析计算 (7) 分析表明，汽车在同步系数为 的路面上制动（前后轮同时抱死）时，其制动减速度g qg dt u 0d ?==，即q=,q 为制动强度。而在其他附着系数 的路面上制动时，达到前轮或者后轮即将抱死的制动强度q<,这表明只有 在=的路面上，地面的附着条件才可以得到充分利用。

详细设计说明书 真正例子

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

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

《微机与单片机综合课程设计说明书》模板蔡才华

《微机与单片机综合课程设计》 说明书 课题名称：基于单片机和DS1302的时钟设计 学号： 02 班级： 13级过程自动化3班 姓名：蔡才华 成绩： 指导教师：陈裕国 课题工作时间： 2016-1-4 至 2016-1-15 武汉工程大学电气信息学院

目录 1.系统分析 ds1302芯片 (6) 引脚图及寄存器 (6) 读写时序说明 (8) 内部电路图 (9) 数码管显示原理 (10) 2.程序设计 总体设计 (11) 分块程序设计 (12) ds1302初始化模块 (13) 数码管显示模块 (16) 主函数模块 (17) 仿真 电路图的搭建 (18) 元件库的选择 (18) 元件的布局 (19) 仿真运行 (21) keil软件的使用 (21) proteus运行效果图 (23) 4.总结 (24)

参考资料 (24) 附录一源程序清单 (25) 附录二电路原理图 (30)

1.系统分析 DS1302时钟芯片 DS1302时钟芯片，该芯片是美国DALLAS公司推出的一种高性能、低功耗的实时时钟芯片，附加31字节静态RAM，采用SPI三线接口与CPU进行同步通信，并可采用突发方式一次传送多个字节的时钟信号和RAM数据。实时时钟可提供秒、分、时、日、星期、月和年，一个月小与31天时可以自动调整，且具有闰年补偿功能。工作电压宽达～。采用双电源供电（主电源和备用电源），可设置备用电源充电方式，提供了对后背电源进行涓细电流充电的能力。 DS1302用于数据记录，特别是对某些具有特殊意义的数据点的记录上，能实现数据与出现该数据的时间同时记录，因此广泛应用于测量系统中。 引脚图及寄存器 内部电路： 各引脚的功能为：

软件概要设计说明书范例

XX概要设计说明书

文档修改记录

填写说明 1. 系统结构的定义 本体系对整个软件系统按如下结构方式进行划分：系统子系统模块子模块 其中： （1）“系统子系统”划分属于“系统设计”，在系统设计说明书中予以描述。 （2）“子系统模块”划分属于“概要设计”，在本说明书中予以描述。 （3）“模块子模块”划分属于“详细设计”，在详细设计说明书中予以描述。如果系统相对简单，可以省略“子模块”这一层次。 2. 如果填写了系统设计说明书，则在本说明书中略过“系统子系统”划分的相关内容（即第2章）。 3. 如果系统相对简单，不需要做“系统子系统”划分，这种情况下，取消填写系统设计说明书，只须填写本说明书，直接套用“子系统模块”划分（即第3章）进行“系统模块”划分（把其中“子系统”一词替换为“系统”），并删除本说明书中“系统子系统”划分的相关内容（第2章）。

目录 1. 简介 ................................................................ 错误!未定义书签。 . 背景和目的.................................................... 错误!未定义书签。 . 范围.......................................................... 错误!未定义书签。 . 术语和缩略语.................................................. 错误!未定义书签。 2. 系统总体设计 ........................................................ 错误!未定义书签。 . 任务概述...................................................... 错误!未定义书签。 目标 .................................................... 错误!未定义书签。 需求概述 ................................................ 错误!未定义书签。 . 设计概述...................................................... 错误!未定义书签。 总体约束 ................................................ 错误!未定义书签。 系统外部接口 ............................................ 错误!未定义书签。 设计方案概述 ............................................ 错误!未定义书签。 . 系统架构设计.................................................. 错误!未定义书签。 系统的逻辑架构设计 ...................................... 错误!未定义书签。 系统的物理架构设计 ...................................... 错误!未定义书签。 . 子系统定义.................................................... 错误!未定义书签。 子系统列表 .............................................. 错误!未定义书签。 子系统间关系 ............................................ 错误!未定义书签。 3. 子系统1设计 ........................................................ 错误!未定义书签。 . 任务概述...................................................... 错误!未定义书签。 目标 .................................................... 错误!未定义书签。 需求概述 ................................................ 错误!未定义书签。 . 设计概述...................................................... 错误!未定义书签。 总体约束 ................................................ 错误!未定义书签。 子系统外部接口 .......................................... 错误!未定义书签。 设计方案概述 ............................................ 错误!未定义书签。 . 子系统架构设计................................................ 错误!未定义书签。 . 模块定义...................................................... 错误!未定义书签。