日志管理详细设计

应用软件详细设计说明书

项目名称：部门级文档管理系统

项目编号：

模块名称：LogManage(日志管理)

模块编号：

编写人员：****

编写日期：

审批人员：

审批日期：

目录

1引言 (3)

1.1编写目的 (3)

1.1.1 目的 (3)

1.1.2 文档预期读者 (3)

1.2项目背景 (3)

1.3定义 (3)

1.4参考资料 (3)

2设计说明 (3)

2.1程序简述 (3)

2.1.1 引用命名空间 (3)

2.1.2 命名空间 (3)

2.1.3 类名 (3)

2.2程序功能描述 (4)

2.2.1 函数列表 (4)

2.2.2 函数功能说明 (4)

2.3注释设计 (5)

2.4限制条件 (5)

2.5测试计划 (6)

2.6尚未解决得问题 (6)

1引言

1.1 编写目的

1.1.1目的

描述部门级文档管理系统LogManage类模块的详细设计。

1.1.2文档预期读者

项目经理、系统分析员、研发经理、测试经理、项目组长、系统开发人员。

1.2 项目背景

由武汉开目信息技术有限责任公司提出，IBM外包小组进行开发。

软件系统名称：部门级文档管理系统。

1.3 定义

1.4 参考资料

需求分析说明书、软件概要设计说明书。

2设计说明

2.1 程序简述

2.1.1引用命名空间

using System;

using System.Data;

using PartDM.DBOperate;

2.1.2命名空间

PartDM. LogManage

2.1.3类名

LogManage

2.2 程序功能描述

2.2.1函数列表

2.2.2函数功能说明

2.2.2.1 查询记录并得到记录集

函数名：AddLog

函数定义：public int Addlog(string SQLstring)

访问权限：public

2.2.2.2 服务器日志查询

函数名：SGetLog

函数定义：public int SGetLog(int logTime,int OState,out DataSet logDataSet)

访问权限：public

2.2.2.3 用于执行内嵌的SWITCH查询字符串

函数名：ExecuteSelect

函数定义：private int ExecuteSelect(int time,int state,out DataSet logDataSet)

访问权限：public

2.3 注释设计

在方法的前面标注注释，描述该方法的功能，参数类型，返回值。

声明变量应标注该变量的用途。

在判断错误的位置加注释，说明是什么错误。

2.4 限制条件

在调用本模块前，有必要先进行注册，将数据库连接串输入到注册表。

要引用DBOperate模块。

2.5 测试计划

请参照单元测试计划说明书。

2.6 尚未解决得问题

无