详细设计说明书_模板_flex技术相关.docVIP

[键入文档副标题] XX项目 详细设计说明书 上海恒志软件科技有限公司 修改记录 版本 日期 修改人 修改内容 V1.0 2010-08- 04 刘宇星 建立初稿。 目录 1 概述 1 1.1 编写目的 1 1.2 阅读范围 1 1.3 名词定义 1 1.4 参考资料 1 2 设计概述 2 2.1 组件关系图及说明 2 2.2 对象模型图及说明 2 2.3 约束和假定 2 3 FLEX界面设计 3 3.1 XX功能 3 3.1.1 Xx模块 3 3.1.1.1 基本界面图 4 3.1.1.2 界面控件说明 4 3.1.1.3 动作及事件说明 5 4 后台ACTION层方法描述 6 4.1 XX ACTION类描述 6 5 后台SERVICE设计 7 5.1 XX SERVICE类描述 7 5.2 重要算法和流程描述 7 5.2.1 方法xxxx 7 6 动作及事件清单 8 7 非功能性需求 9 1 概述 1.1 编写目的 1.2 阅读范围 1.3 名词定义 1.4 参考资料 2 设计概述 2.1 组件关系图及说明 描述系统/子系统/模块中组件的构成，关系等。 2.2 对象模型图及说明 对于一些复杂的对象设计，用图（例如：UML等）表示所有业务类和关 键控制类之间的对象关系，如果模型过大，按照功能类别或层次划分等 方式分开成多个图表述。 2.3 约束和假定 描述系统设计中最主要的约束，这些是由客户强制要求并在产品需求说 明书写明的。说明系统是如何来适应这些约束的。 另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功 能辅助，那么系统可能还受到其它的约束。这种情况下，要求清楚地描 述与本系统有交互的软件类型（比如某某某数据库软件，某某某EMail 软件）以及这样导致的约束（比如只允许纯文本的Email）。 实现的语言和平台也会对系统有约束，同样在此予以说明。 如果在其他文档有明确描述，则可写明参见文档，例如《项目建设方 案》。 3 FLEX界面设计 本节Flex界面部分的设计。 3.1 Xx功能 导航图： 功能模块路径： 一级目录 二级目录 功能模块路径 说明 3.1.1 Xx模块 文件名称：xxx.xx.xx.xx.mxml 顶层控件：moduel 3.1.1.1 基本界面图 3.1.1.2 界面控件说明 根据上述界面描述各个区域所含控件 界面单元 包含控件及ID 控制条件 数据来源 用途 Xx区域 Xx类型控件 如果区域中有DataGrid，填写下表 DataGrid 名称 Xxxxgrid 列名称 字段类 型 是否必填 （如果不 必填，下 保存 后是 否可 控件 类型 是否 只读 数据来 源(下拉 框来源 拉框必须 修改 或者其 能够选 空） 他过滤 条件) 3.1.1.3 动作及事件说明 3.1.1.3.1 Xx1动作 动作函数 Xxxxxx函数 来源控件 新增按钮，click事件 调用接口 无 功能说明 1. 执行逻辑1 2. 执行逻辑2 3. 执行逻辑3 3.1.1.3.2 Xx2动作 动作函数 Xxxxxxxxxx 来源控件 删除按钮，click事件 动作说明 描述调用后台Action的方法 调用接口方 法 入参来源 参数名称 参数来源控件 特殊处理 参数1 参数2 返回结果类型 返回结果处 理 处理函数 处理调用Action的handle函数 处理过程 描述handle函数的逻辑 1. 执行逻辑1 2. 执行逻辑2 4 后台Action层方法描述 4.1 Xx Action类描述 类名 xx.xx.xxxxAction 继承类或者接口 GeneralAction 方法 说明 方法名1：包括作用域，返回 值，入参类型，异常等 逻辑说明1 方法名2：包括作用域，返回 值，入参类型，异常等 备注 逻辑说明2 5 后台Service设计 本节描述后台java Service的设计。 5.1 Xx Service类描述 实现类 xxxx.xxx.xxx.XXXXXServiceBean 继承类或者接口 xxxx.xxx.xxx.IXXXXXSerivce 方法(出入 事务配置 说明 参数及异 常) 法名1：包括作 域，返回值，入 类型，异常等 逻辑说明1 5.2 重要算法和流程描述 5.2.1 方法xxxx 描述本业务类接口中重要的、复杂的算法内容，这些内容在上表 中“方法”对应的“说明”中无法简单的描述清楚。 如果上表可以完全描述清晰，本章节可以省略。 6 动作及事件清单 一级界面模块 二级界面模块 动作和事件 备注说明 名称 名称 XX功能 xx模块 Xx动作1 Xx动作1 7 非功能性需求 在这个部分说明如何处理需求文档中指定的非功能性需求。 尽可能客观地评估系统应付每一个非功能性的需求的能力程度。如