模块设计报告VIP专享VIP免费

综合学校网站模块设计报告文件状态：文件标识：SD-MODULE3］草稿当前版本：［］正式发布作者：梁文江［］正在修改完成日期：2010-12-16错误!未定义书签错误!未定义书签错误!未定义书签错误!未定义书签文档目的文档范围读者对象1.模块命名规则0.文档介绍错误!未定义书签。2.模块汇总错误!未定义书签。模块汇总表错误!未定义书签。模块关系图错误!未定义书签3.子系统前台的模块设计错误!未定义书签。4.子系统后台的模块设计错误!未定义书签。0.文档介绍文档目的说明学校网站的设计过程，各应用模块的主要接口与属性、数据结构和算法。文档范围项目经理指定若干名开发人员从事模块的设计（以下称为模块设计人员），模块设计人员将在实现阶段编写这些模块的代码读者对象模块设计人员，测评人员1.模块命名规则(I) 用 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)文件名要能反应类的内容，最好是和类同名，一个文件中一个类或一组关连类.(II)目录结构中要反应出 namespace 的层次.(12)大括号"{"要新起一行(13) 、避免容易被主观解释的难懂的名称，如方面名 AnalyzeThis(),或者属性名 xxK8。这样的名称会导致多义性。(14) 、只要合适，在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。(15) 、布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值，如 fileIsFound。(16)、在命名状态变量时，避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag，而是使用更具描述性的名称，如documentFormatType。（此项只供参考）（17）、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 ...