系统实现文档编写规范及示例.docx
《系统实现文档编写规范及示例.docx》由会员分享，可在线阅读，更多相关《系统实现文档编写规范及示例.docx（6页珍藏版）》请在冰豆网上搜索。
系统实现文档编写规范及示例
********系统
系统实现文档
*****系统实现小组
组长：
****
组员：
****
****
****
****
说明：
●将所实现的系统按模块说明实现方法，在每个模块的实现中分别写明：
该模块用到的相关类、数据库表、文件及界面跳转关系、程序流程图、以及界面截图。
并对各部分进行相应的说明。
●文档中每章图都需要配有相应的文字解释。
●本文档中的图按照章编号，如“1引言”表示第一章，“1.1编写目的”表示第一章第一节。
第一章第一个图标号为“图1.1****图”，而第二个图标号为“图1.2****图”，写在图的下面，居中。
●本文档中的表也按照章编号，第一章第一个表标号为“表1.1****表”，而第二个表标号为“表1.2****表”，写在表的上面，居中。
●使用visio画用例时，Actor及用例的图示模具（用例图模具.vss）可以到BB平台下载。
1系统通用类实现
说明：
●此部分内容不是必须的，但建议写。
●近可能列出所有通用类的实现。
示例如下：
把经常用到的操作封装在通用类中，需要用到哪种操作的时候直接调用封装好的类就可以实现操作。
这样可以实现代码的可重用性，大大节省编写程序的时间。
本系统将所有通用类都放入Classes文件夹中，以便形成自己的命名空间，如图5.2所示。
图5.2系统通用类管理
1.1数据库通用类实现
数据库通用类由OleBase类实现，它是应用程序通过ADO.NET访问数据库的基础类，也是应用程序实现上层业务逻辑的基础。
该类主要封装了创建访问数据库的一些对象和方法，如数据连接对象：
一个静态的字符串变量strConn存储数据库连接字符串。
以及执行数据库操作的对象和方法，如Command对象等。
另外，OleBase类还专门定义了一个字符串变量strSQL存储SQL语句[6]。
其中，OleBase类中提供了六个数据访问方法，他们执行类似的动作，如表5.1所示。
表5.1OleBase类中的6个数据访问方法列表
函数名
函数需要执行的操作
intExecuteSql（stringstrSQL）
执行不返回数据集的SQL语句。
intExecuteSqlEx（stringstrSQL）
执行SQL语句,判断是否返回数据：
不返回数据则抛出"ValueUnavailable!
"异常。
1.2其它通用类实现
（1）字符串操作类Functions：
把对字符串的操作封装在Functions类里面。
Functions类的主要功能是替换特殊字符串、对输入的密码加密和解密、移除字符串的特殊位等操作。
（2）商品信息类Product：
把对商品基本信息表Product的操作封装在Product类里面。
Product类继承自数据通用类OleBase，这样Product类就可以拥有基本数据库操作的功能。
2AAA模块实现
2.1AAA模块实现简介
说明实现该模块的基本方法和过程。
示例：
只有拥有发改局权限的用户可以管理指标数据。
管理目标包括全区计划指标，全区指标管理，实际利用外资明细管理，乡街计划指标和乡街指标管理。
对于每一个管理项目都可以进行查询，修改，详情和删除操作。
在进行管理的时候，若指定查询目标或者查询范围，即可显示相应数据。
否则将显示全部的数据。
数据的显示方式是按照录入时间分页显示。
该模块用到的数据库表有xjzd、xjzbzd、qqzbzd、dwzd、xjzbcc、qqzbcc、qqjh、xjjh、sjlywzmxb、mxb_tempgl、gmjj_tempgl、gmjj_inputexl。
2.2AAA模块相关类实现
针对该模块用到的每个类，说明各个属性含义、各个方法的功能。
2.3AAA模块文件及跳转关系
详细列出该模块用到的文件及其跳转关系。
示例：
（1）模块涉及代码文件列表如表2.1所示。
表2.1AAA模块涉及代码文件列表
文件名
文件路径
文件说明
shoppingCart.aspx
D:
\studynet\shop
前台HTML脚本编辑文件，实现购物车界面。
shoppingCart.aspx.cs
D:
\studynet\shop
后台C#代码文件，实现更新购物车，清空购物车等响应方法。
（2）模块涉及页面跳转关系图，如图2.1所示。
图2.1AAA模块涉及界面跳转关系图
2.4AAA模块程序流程
列出实现该模块的程序流程图并进行相应解释。
示例：
AAA模块实现程序流程如图2.2所示。
图中。
。
。
。
。
。
。
。
。
。
。
。
（解释说明）
图2.2AAA模块程序流程图
2.5AAA模块实现界面
列出该模块运行时所生成的界面截图。
示例：
AAA模块实现界面如图2.3-2.X所示。
图2.3AAA模块实现界面1
图2.4AAA模块实现界面2
3BBB模块实现
说明：
●参照AAA模块写法编写；
●有几个模块就写几章。
X小结
对系统实现结果进行总结。
升级会员 