第一组模块设计报告.docx
《第一组模块设计报告.docx》由会员分享，可在线阅读，更多相关《第一组模块设计报告.docx（10页珍藏版）》请在冰点文库上搜索。
第一组模块设计报告
机构图标
{.net在线学习系统}
模块设计报告
文件状态：
[√]草稿
[]正式发布
[]正在修改
文件标识：
Company-Project-SD-MODULE
当前版本：
X.Y
作者：
张亚程亚辉孟军燕李三想
完成日期：
Year-Month-Day
第一组
张亚程亚辉孟军燕李三想
版本历史
版本/状态
作者
参与者
起止日期
备注
0.文档介绍
0.1文档目的
说明在线学习系统的设计过程，各应用模块的主要接口与属性、数据结构和算法
.2文档范围
1.模块命名规则
2.模块汇总
3.子系统A的模块设计
4.子系统B的模块设计
5.其他
0.3读者对象
模块设计人员，测评人员
0.4参考文献
提示：
列出本文档的所有参考文献（可以是非正式出版物），格式如下：
[标识符]作者，文献名称，出版单位（或归属单位），日期
例如：
[AAA]作者，《立项建议书》，机构名称，日期
[SPP-PROC-SD]SEPG，系统设计规范，机构名称，日期
0.5术语与缩写解释
缩写、术语
解释
SPP
精简并行过程，SimplifiedParallelProcess
SD
系统设计，SystemDesign
…
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#命名规范为准。
2.模块汇总
2.1模块汇总表
提示：
这里模块是指相对独立的软件设计单元，例如对象类、函数包等等。
子系统A在线学习系统的前台
模块名称
功能简述
注册
用户注册成为会员
登录
给予用户登录在线学习
资料上传
给予用户上传资料
在线留言
给予用户可以留言
资料下载
给予用户可以下载相关的资料
公告浏览
给予用户浏览
个人信息管理
给予用户查询
子系统B在线学习系统的后台
模块名称
功能简述
公告发布
管理员可以发布公告
用户信息管理
管理员可以对信息进行管理
登录
管理员可以登录
2.2模块关系图
提示：
参考体系结构设计文档
登陆模块关系图
学生模块关系图
教师模块关系图
管理员模块关系图
3.子系统前台模块设计
模块名称
登录
功能描述
用户登录
接口与属性
函数带三个参数：
用户ID、用户密码、用户类型
数据结构
与算法
采用“顺序查找”的方法
补充说明
查找是否有此用户时，把参数与数据库的参数做对比，是否一致
模块名称
注册
功能描述
给予用户注册会员
接口与属性
函数带三个参数：
用户ID、用户密码、用户类型用户邮箱、验证码
数据结构
与算法
无
补充说明
用户密码与验证码是否一致
模块名称
资料上传
功能描述
上传资料
接口与属性
函数带三个参数：
用户ID、用户密码、用户类型
数据结构
与算法
采用“顺序查找”的方法
补充说明
查找是否上传资料，把参数与数据库的参数做对比，是否一致
模块名称
在线留言
功能描述
可以发表意见
接口与属性
可以留言与该网站有关的信息
数据结构
与算法
采用“顺序查找”的方法
补充说明
查找是否留言时，把参数与数据库的参数做对比，是否一致
模块名称
资料下载
功能描述
下载资料
接口与属性
函数带三个参数：
用户ID、用户密码、用户类型
数据结构
与算法
采用“顺序查找”的方法
补充说明
查找是否有下载时，把参数与数据库的参数做对比，是否一致
模块名称
公告浏览
功能描述
用户可以浏览公告
接口与属性
函数带三个参数：
用户ID、用户密码、用户类型
数据结构
与算法
采用“顺序查找”的方法
补充说明
查找是否公告浏览时，把参数与数据库的参数做对比，是否一致
模块名称
个人信息管理
功能描述
用户可以查询自己的个人信息
接口与属性
函数带三个参数：
用户ID、用户密码、用户类型
数据结构
与算法
采用“顺序查找”的方法
补充说明
查找是否有个人信息管理时，把参数与数据库的参数做对比，是否一致
4.子系统后台模块设计
模块名称
公告发布
功能描述
用户可以浏览公告
接口与属性
利用数据控件对数据库修改等
数据结构
与算法
无
补充说明
模块名称
用户信息管理
功能描述
用户可以查询自己的个人信息
接口与属性
利用数据控件对数据库修改等
数据结构
与算法
无
补充说明
模块名称
登录
功能描述
用户登录
接口与属性
利用数据控件对数据库修改等
数据结构
与算法
无
补充说明
5.其他
升级会员 