[RSS阅读器系统]详细设计说明书.docVIP

RSS阅读器系统详细设计说明书 2010-11-10 文件变更记录 *A – 增加 M – 修改 D – 删节 变更版本 日期 图表、表格、段落号 A/M/D 原因与修改情况描述 修订人 审核人 V1.0 2007/09/15 A 目 录 目 录 i 1 引言 1 1.1 编写目的 1 1.2 背景 1 1.3 定义 1 1.4 参考资料 1 2 程序系统的结构 2 3 UI界面模块设计说明 2 3.1程序描述 2 3.2 功能 2 3.3 性能 3 3.4 输入项 3 3.5 输出项 4 3.6 算法 4 3.7 流程逻辑 5 3.8 接口 5 3.9 存储分配 5 3.10 注释设计 5 3.11 限制条件 6 4 系统后台逻辑设计说明 7 4.1程序描述 7 4.2 功能 7 4.3 性能 7 4.4 输入项 7 4.5 输出项 8 4.6 算法 8 4.7 流程逻辑 9 4.8 接口 9 4.9 存储分配 9 4.10 注释设计 9 4.11 限制条件 10 5 系统UI菜单设计说明 10 1 引言 1.1 编写目的 编制目的是说明一个软件系统各个层次中的每一个程序的设计考虑。该文件可作为公司软件开发人员、综合测试人员、系统实施人员的指导性文件。同时也是对以上人员进行具体工作的约束文件。要求相关人员的具体工作符合本设计的具体要求与约束。 1.2 背景 a.开发的软件系统的名称 中文全称：RSS阅读器系统详细设计说明书 中文简称：RSS b.开发的软件系统的最终用户或适用的领域； 本系统最终用户为个人与企业用户. 适应角色为：一般用户均可. 1.3 定义 RSS 是站点用来和其他站点之间共享内容的一种简易方式（也叫聚合内容）1.4 参考资料 RSS资料阅览器需求说明书 2 程序系统的结构 用一系列图表的方式列出本程序系统内的每个程序的名称、标识符和层次结构关系。系统整体层次结构： 3 UI界面模块设计说明 3.1程序描述 系统的UI界面包括主界面,频道增加,修改,显示,删除功能的界面设计.此界面为系统完成基本功能的最低系统要求 3.2 功能 系统主界面显示 增加频道 修改频道 删除频道 3.3 性能 系统的显示要求较快，一般显示出网页信息平均时间一般不超过5秒钟（忽略网络因素）；其他操作基本不会出现延迟现象。 3.4 输入项 系统的正常使用,需要先设置频道内容.设置频道内容的方式如下: (图1: 频道的添加)  3.5 输出项 (图2: 频道的阅览) 3.6 算法 1．系统采用.NET的技术框架构建. 系统主界面采用contextMenuStrip的类型控件作为系统的树形菜单.Web 内容的输出采用webBrowser控件. 2: 系统的添加频道功能的数据内容是通过FeedBase 对象传入系统后台. 3.7 流程逻辑 系统的添加频道功能的流程逻辑: 3.8 接口 本模块与系统后台逻辑通过BaseFeed对象的DisplayName,url 属性写入用户属性文件中. 3.9 存储分配 无需存储分配. 3.10 注释设计 每个java文件在首部标明文件的功能，作者，创建时间。 每个方法标明功能，参数和返回值标明中文含义。 对各变量的功能、范围、缺省条件等标明含义。 对使用的逻辑所标明含义。 3.11 限制条件 1．本系统使用到的配置信息要在上线前完整录入，保证正确无误  4 系统后台逻辑设计说明 4.1程序描述 本模块的功能主要是根据用户维护的”频道”地址,提取相关数据以网页形式显示在系统主界面中. XML的类型为RSS标准规范,详细可参考相关资料. 4.2 功能 本系统的后台逻辑描述如下: 1: 系统”频道”内容的添加. 用户添加的”频道”内容,存在一个属性文件中.(名称可随意,本项目定为”user.profile”). 2: 根据用户添加的属性文件(XML类型文件)提取XML数据下载到本地. (名称可随意,本项目定为”temp.rss”). 3: 解析最新的XML数据文件,提取对应本频道相应的文章标题与文章对应URL,存入系统集合对象中. 4: 系统在启动初始化时,载入系统集合对象中所有的数据显示在主见面树形菜单中. 4.3 性能 XML数据的下载与查询平均时间一般不超过5秒钟（忽略网络因素）. 4.4 输入项 用户属性文件. ( 例:user.profile) 4.5 输出项 用户属性文件定义频道对应的网页信息