第一组( 模块设计报告)

{.net在线学习系统}模块设计报告文件状态：[√]草稿[]正式发布[]正在修改文件标识：Company-Project-SD-MODULE当前版本：X.Y作者：张亚程亚辉孟军燕李三想完成日期：Year-Month-Day机构图标第一组张亚程亚辉孟军燕李三想项目名称，《模块设计报告》机构名称，2002Page2of10版本历史版本/状态作者参与者起止日期备注项目名称，《模块设计报告》机构名称，2002Page3of10目目录录0.文档介绍............................................................................................................................40.1文档目的.......................................................................................................................40.2文档范围.......................................................................................................................40.3读者对象.......................................................................................................................40.4参考文献.......................................................................................................................40.5术语与缩写解释............................................................................................................41.模块命名规则.....................................................................................................................52.模块汇总............................................................................................................................62.1模块汇总表...................................................................................................................62.2模块关系图...................................................................................................................63.子系统A的模块设计........................................................................................................83.N模块A-N........................................................................................错误!未定义书签。4.子系统B的模块设计......................................................................................................104.N模块B-N.........................................................................................错误!未定义书签。5.其他..................................................................................................................................10项目名称，《模块设计报告》机构名称，2002Page4of100.文档介绍0.1文档目的说明在线学习系统的设计过程，各应用模块的主要接口与属性、数据结构和算法.2文档范围1.模块命名规则2.模块汇总3.子系统A的模块设计4.子系统B的模块设计5.其他0.3读者对象模块设计人员，测评人员0.4参考文献提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下：[标识符]作者，文献名称，出版单位（或归属单位），日期例如：[AAA]作者，《立项建议书》，机构名称，日期[SPP-PROC-SD]SEPG，系统设计规范，机构名称，日期0.5术语与缩写解释缩写、术语解释SPP精简并行过程，SimplifiedParallelProcessSD系统设计，SystemDesign…项目名称，《模块设计报告》机构名称，2002Page5of101.模块命名规则（1）用C#规则来命名方法和类，类名和应用类的模块英文名称一致。（news,chatroom）（2.）用C#规则来命名局部变量和方法的参数,因为各模块与数据库有联系，所以变量名称和数据库中表的字段名车让你更一致。（3）接口的名称加前缀IinterfaceICompare{intcompare();}（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函数。如果以上未做规定，以vs2005的C#命名规范为准。项目名称，《模块设计报告》机构名称，2002Page6of102.模块汇总2.1模块汇总表提示：这里模块是指相对独立的软件设计单元，例如对象类、函数包等等。子系统A在线学习系统的前台模块名称功能简述注册用户注册成为会员登录给予用户登录在线学习资料上传给予用户上传资料在线留言给予用户可以留言资料下载给予用户可以下载相关的资料公告浏览给予用户浏览个人信息管理给予用户查询子系统B在线学习系统的后台模块名称功能简述公告发布管理员可以发布公告用户信息管理管理员可以对信息进行管理登录管理员可以登录2.2模块关系图提示：参考体系结构设计文档登录模块学生登录教师登录管理员登陆登陆模块关系图项目名称，《模块设计报告》机构名称，2002Page7of10学生模块在线学习在线留言聊天室下载资料管理个人信息学生模块关系图教师模块上传资料聊天室下载资料管理个人信息教师模块关系图项目名称，《模块设计报告》机构名称，2002Page8of10管理员模块发布公告管理学生信息管理教师信息管理员模块关系图3.子系统前台模块设计模块名称登录功能描述用户登录接口与属性函数带三个参数：用户ID、用户密码、用户类型数据结构与算法采用“顺序查找”的方法补充说明查找是否有此用户时，把参数与数据库的参数做对比，是否一致模块名称注册功能描述给予用户注册会员接口与属性函数带三个参数：用户ID、用户密码、用户类型用户邮箱、验证码数据结构与算法无补充说明用户密码与验证码是否一致项目名称，《模块设计报告》机构名称，2002Page9of10模块名称资料上传功能描述上传资料接口与属性函数带三个参数：用户ID、用户密码、用户类型数据结构与算法采用“顺序查找”的方法补充说明查找是否上传资料，把参数与数据库的参数做对比，是否一致模块名称在线留言功能描述可以发表意见接口与属性可以留言与该网站有关的信息数据结构与算法采用“顺序查找”的方法补充说明查找是否留言时，把参数与数据库的参数做对比，是否一致模块名称资料下载功能描述下载资料接口与属性函数带三个参数：用户ID、用户密码、用户类型数据结构与算法采用“顺序查找”的方法补充说明查找是否有下载时，把参数与数据库的参数做对比，是否一致模块名称公告浏览功能描述用户可以浏览公告接口与属性函数带三个参数：用户ID、用户密码、用户类型数据结构与算法采用“顺序查找”的方法补充说明查找是否公告浏览时，把参数与数据库的参数做对比，是否一致模块名称个人信息管理功能描述用户可以查询自己的个人信息接口与属性函数带三个参数：用户ID、用户密码、用户类型数据结构采用“顺序查找”的方法项目名称，《模块设计报告》机构名称，2002Page10of10与算法补充说明查找是否有个人信息管理时，把参数与数据库的参数做对比，是否一致4.子系统后台模块设计模块名称公告发布功能描述用户可以浏览公告接口与属性利用数据控件对数据库修改等数据结构与算法无补充说明模块名称用户信息管理功能描述用户可以查询自己的个人信息接口与属性利用数据控件对数据库修改等数据结构与算法无补充说明模块名称登录功能描述用户登录接口与属性利用数据控件对数据库修改等数据结构与算法无补充说明5.其他