模块设计报告1

综合学校网站 模块设计报告 文件标识 SD MODULE 当前版本 1 0 作 者 梁文江 文件状态 草稿 正式发布 正在修改 完成日期 2010 12 16 项目名称 模块设计报告 Page 2 of 8 目目目 录录录 0 文档介绍文档介绍 3 0 1 文档目的 3 0 2 文档范围 3 0 3 读者对象 3 1 模块命名规则模块命名规则 4 2 模块汇总模块汇总 5 2 1 模块汇总表 5 2 2 模块关系图 5 3 子系统前台的模块设计子系统前台的模块设计 5 4 子系统后台的模块设计子系统后台的模块设计 5 项目名称 模块设计报告 Page 3 of 8 0 文档介绍文档介绍 0 1 文档目的文档目的 说明学校网站的设计过程 各应用模块的主要接口与属性 数据结构和算法 0 2 文档范围文档范围 项目经理指定若干名开发人员从事模块的设计 以下称为模块设计人员 模块设计人员将 在实现阶段编写这些模块的代码 0 3 读者对象读者对象 模块设计人员 测评人员 项目名称 模块设计报告 Page 4 of 8 1 模块命名规则模块命名规则 1 用 C 规则来命名方法和类 类名和应用类的模块英文名称一致 news chatroom 2 用 C 规则来命名局部变量和方法的参数 因为各模块与数据库有联系 所以变量名称和 数据库中表的字段名车让你更一致 3 接口的名称加前缀 I interface ICompare int compare 4 局部变量的名称要有意义 不要用 x y z 等等 除用于 For 循环变量中可使用 i j k l m n 5 所有的成员变量声明在类的顶端 用一个换行把它和方法分开 6 采用默认的名字命名 namespace 如 产品名 公司名 7 建议局部变量在最接近使用它时再声明 8 使用某个控件的值时 尽量命名局部变量 9 把引用的系统的 namespace 和自定义或第三方的用一个换行把它们分开 10 文件名要能反应类的内容 最好是和类同名 一个文件中一个类或一组关连类 11 目录结构中要反应出 namespace 的层次 12 大括号 要新起一行 13 避免容易被主观解释的难懂的名称 如方面名 AnalyzeThis 或者属性名 xxK8 这 样的名称会导致多义性 14 只要合适 在变量名的末尾或开头加计算限定符 Avg Sum Min Max Index 15 布尔变量名应该包含 Is 这意味着 Yes No 或 True False 值 如 fileIsFound 16 在命名状态变量时 避免使用诸如 Flag 的术语 状态变量不同于布尔变量的地方是 它可以具有两个以上的可能值 不是使用 documentFlag 而是使用更具描述性的名称 如 documentFormatType 此项只供参考 17 即使对于可能仅出现在几个代码行中的生存期很短的变量 仍然使用有意义的名称 仅对于短循环索引使用单字母变量名 如 i 或 j 可能的情况下 尽量不要使用原义数字或 原义字符串 18 可使用约定俗成的缩写使名称长度适中 19 在内部范围中避免使用与外部范围中的名称相同的名称 如果访问了错误的变量 则可能会产生错误结果 若变量与同一名称的关键字冲突 则必须在关键字前加适当的类型 库以作标识 例如 如果有一个名为 Date 的变量 通过调用 System DateTime Date 只可以使 用内部 Date 函数 如果以上未做规定 以 vs 2005 的 C 命名规范为准 项目名称 模块设计报告 Page 5 of 8 2 模块汇总模块汇总 2 1 模块汇总表模块汇总表 子系统子系统 A 网站前台网站前台 模块名称功能简述 用户登录给予用户登录网站 客户注册客户注册成为本站会员 分类搜索客户可以搜索相关产品 聊天新用户注册后可以进入聊天 购物车实时显示用户当前所购产品 可以增加或删除 订单查询客户依此号码可以查询所购产品数目与产品情况 子系统 B 网站后台 模块名称功能简述 后台用户管理普通用户的添加 删除 修改 后台订单管理实现对订单的添加 删除 修改管理 后台产品信息管理实现分类管理 类别设置 厂家管理 客户权限管理管理人员实现对用户的分级 项目名称 模块设计报告 Page 6 of 8 2 2 模块关系图模块关系图 电子商务系统电子商务系统 前 台 显 示 商 品 管 理 订 单 管 理 登 陆 注 册 商 品 购 买 结 账 热 卖 商 品 打 折 促 销 添 加 商 品 修 改 商 品 删 除 商 品 查 询 商 品 订 单 修 改 订 单 删 除 订 单 查 询 用 户 登 录 用 户 注 册 放 入 购 物 车 生 成 订 单 结 账 返 回 首 页 品 牌 种 类 提示 提示 参考体系结构设计文档 项目名称 模块设计报告 Page 7 of 8 3 子系统前台的模块设计子系统前台的模块设计 模块名称用户登录 功能描述普通用户的登录 接口与属性函数带三个参数 用户 ID 用户密码 用户类型 数据结构与算法采用 顺序查找 的方法 补充说明查找是否有此用户时 把参数与数据库的参数做对比 是否一致 模块名称客户注册 功能描述给予客户注册会员 接口与属性函数带三个参数 用户 ID 用户密码 用户邮箱 验证码 数据结构与算法无 补充说明用户密码与验证码是否一致 模块名称分类搜索 功能描述搜索相关产品 接口与属性产品型号的参数 数据结构与算法采用 顺序查找 的方法 补充说明搜索时忽略空字符 如果没有则提示 搜索不到该信息 模块名称聊天 功能描述咨询客服相关信息 接口与属性QQ 所需一些参数 模块名称购物车 功能描述查看要购买的产品 接口与属性删除物品 返回 结账参数 模块名称订单查询 功能描述查询相关产品 接口与属性订单号的参数 数据结构与算法采用 顺序查找 的方法 补充说明搜索时忽略空字符 项目名称 模块设计报告 Page 8 of 8 4 子系统后台的模块设计子系统后台的模块设计 模块名称用户管理 功能描述对用户的添加 删除 修改 接口与属性利用数据控件对数据库修改等 数据结构与算法无 补充说明 模块名称订单管理 功能描述对订单删除 修改 接口与属性利用数据控件对数据库修