模块设计报告1.doc

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