第一组(-模块设计报告)

.net 在线学习系统 模块设计报告 文件标识：Company-Project-SD-MODULE 当前版本：X.Y 作 者：张亚 程亚辉 孟军燕 李三想 文件状态： 草稿 正式发布 正在修改 完成日期：Year-Month-Day 机构图标 第一组第一组 张亚张亚 程亚辉程亚辉 孟军燕孟军燕 李三想李三想 项目名称， 模块设计报告 机构名称，2002Page 2 of 10 版 本 历 史 版本/状态作者参与者起止日期备注 项目名称， 模块设计报告 机构名称，2002Page 3 of 10 目目目 录录录 0. 文档介绍文档介绍.4 0.1 文档目的.4 0.2 文档范围.4 0.3 读者对象.4 0.4 参考文献.4 0.5 术语与缩写解释.4 1. 模块命名规则模块命名规则.5 2. 模块汇总模块汇总.5 2.1 模块汇总表.5 2.2 模块关系图.5 3. 子系统子系统 A 的模块设计的模块设计 .6 3.N 模块 A-N.6 4. 子系统子系统 B 的模块设计的模块设计.6 4.N 模块 B-N.6 5. 其他其他.6 项目名称， 模块设计报告 机构名称，2002Page 4 of 10 0. 文档介绍文档介绍 0.1 文档目的文档目的 说明在线学习系统的设计过程，各应用模块的主要接口与属性、数据结构和算法 .2 文档范围文档范围 1.模块命名规则 2. 模块汇总 3. 子系统 A 的模块设计 4. 子系统 B 的模块设计 5. 其他 0.3 读者对象读者对象 模块设计人员，测评人员 0.4 参考文献参考文献 提示：提示：列出本文档的所有参考文献（可以是非正式出版物） ，格式如下： 标识符 作者，文献名称，出版单位（或归属单位） ，日期 例如：例如： AAA 作者， 立项建议书 ，机构名称，日期 SPP-PROC-SD SEPG，系统设计规范，机构名称，日期 0.5 术语与缩写解释术语与缩写解释 缩写、术语缩写、术语解解 释释 SPP精简并行过程，Simplified Parallel Process SD系统设计，System Design 项目名称， 模块设计报告 机构名称，2002Page 5 of 10 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、Inde） 。 （15） 、布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值，如 fileIsFound。 （16） 、在命名状态变量时，避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地 方是它可以具有两个以上的可能值。不是使用 documentFlag，而是使用更具描述性的名称， 如 documentFormatType。 （此项只供参考） （17） 、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名 称。仅对于短循环索引使用单字母变量名，如 i 或 j。 可能的情况下，尽量不要使用原 义数字或原义字符串。 （18） 、可使用约定俗成的缩写使名称长度适中， （19） 、在内部范围中避免使用与外部范围中的名称相同的名称。如果访问了错误的变量， 则可能会产生错误结果。若变量与同一名称的关键字冲突，则必须在关键字前加适当的 类型库以作标识。 例如，如果有一个名为 Date 的变量，通过调用 System.DateTime.Date 只可以使用部 Date 函 数。 如果以上未做规定，以 vs 2005 的 C#命名规范为准。 项目名称， 模块设计报告 机构名称，2002Page 6 of 10 2. 模块汇总模块汇总 2.1 模块汇总表模块汇总表 提示：提示：这里模块是指相对独立的软件设计单元，例如对象类、函数包等等。 子系统子系统 A 在线学习系统的前台 模块名称功能简述 注册用户注册成为会员 登录给予用户登录在线学习 资料上传给予用户上传资料 在线留言给予用户可以留言 资料下载给予用户可以下载相关的资料 公告浏览给予用户浏览 个人信息管理给予用户查询 子系统子系统 B 在线学习系统的后台在线学习系统的后台 模块名称功能简述 公告发布管理员可以发布公告 用户信息管理管理员可以对信息进行管理 登录管理员可以登录 2.2 模块关系图模块关系图 提示：提示：参考体系结构设计文档 登录模块 学生登录 教师登录 管理员登陆 登陆模块关系图 项目名称， 模块设计报告 机构名称，2002Page 7 of 10 学生模块 在线学习 在线留言 聊天室 下载资料 管理个人信 息 学生模块关系图 教师模块 上传资料 聊天室 下载资料 管理个人信 息 教师模块关系图 项目名称， 模块设计报告 机构名称，2002Page 8 of 10 管理员模块 发布公告 管理学生信息 管理教师信息 管理员模块关系图 3. 子系统前台模块设计子系统前台模块设计 模块名称登录 功能描述用户登录 接口与属性 函数带三个参数：用户 ID、用户密码、用户类型 数据结构 与算法 采用采用“顺序查找顺序查找”的方法的方法 补充说明查找是否有此用户时，把参数与数据库的参数做对比，是否一致 模块名称注册 功能描述给予用户注册会员 接口与属性 函数带三个参数：用户 ID、用户密码、用户类型用户邮箱、验证码 数据结构 与算法 无 补充说明用户密码与验证码是否一致用户密码与验证码是否一致 项目名称， 模块设计报告 机构名称，2002Page 9 of 10 模块名称资料上传 功能描述上传资料 接口与属性 函数带三个参数：用户 ID、用户密码、用户类型 数据结构 与算法 采用采用“顺序查找顺序查找”的方法的方法 补充说明查找是否上传资料，把参数与数据库的参数做对比，是否一致 模块名称在线留言 功能描述可以发表意见 接口与属性 可以留言与该网站有关的信息 数据结构 与算法 采用采用“顺序查找顺序查找”的方法的方法 补充说明查找是否留言时，把参数与数据库的参数做对比，是否一致 模块名称资料下载 功能描述下载资料 接口与属性 函数带三个参数：用户 ID、用户密码、用户类型 数据结构 与算法 采用采用“顺序查找顺序查找”的方法的方法 补充说明查找是否有下载时，把参数与数据库的参数做对比，是否一致 模块名称公告浏览 功能描述用户可以浏览公告 接口与属性 函数带三个参数：用户 ID、用户密码、用户类型 数据结构 与算法 采用采用“顺序查找顺序查找”的方法的方法 补充说明查找是否公告浏览时，把参数与数据库的参数做对比，是否一致 模块名称个人信息管理 功能描述用户可以查询自己的个人信息 接口与属性 函数带三个参数：用户 ID、用户密码、用户类型 数据结构采用“顺序查找”的方法 项目名称， 模块设计报告 机构名称，2002Page 10 of 10 与算法 补充说明查找是否有个人信息管理时，把参数与数据库的参数做对比，是否一致 4. 子系统后台模块设计子系统后台模块设计 模块名称公告发布 功能描述用户可以浏览公告 接口与属性 利用数据控件对数据库修改等