日志管理详细设计

1、卷号 卷内编号 密级 应用软件详细设计说明书应用软件详细设计说明书 项目名称：项目名称： 部门级文档管理系统部门级文档管理系统 项目编号：项目编号： 模块名称：模块名称： LogManage(LogManage(日志管理日志管理) ) 模块编号：模块编号： 编写人员：编写人员： * 编写日期：编写日期： 审批人员：审批人员： 审批日期：审批日期： 历史修改记录 版本号修改人/日期摘要审定人/日期 目录目录 1 1引言引言 .2 2 1.11.1 编写目的编写目的.2 1.1.1 目的 .2 1.1.2 文档预期读者 .3 1.21.2 项目背景项目背景.3 1.31.3 定义定义.3 1.41

2、.4 参考资料参考资料.3 2 2设计说明设计说明 .3 3 2.12.1 程序简述程序简述.3 2.1.1 引用命名空间 .3 2.1.2 命名空间 .3 2.1.3 类名 .3 2.22.2 程序功能描述程序功能描述.3 2.2.1 函数列表 .3 2.2.2 函数功能说明 .4 2.32.3 注释设计注释设计.9 2.42.4 限制条件限制条件.9 2.52.5 测试计划测试计划.9 2.62.6 尚未解决得问题尚未解决得问题.9 1 引言引言 1.1 编写目的编写目的 1.1.1 目的 描述部门级文档管理系统 LogManage 类模块的详细设计。 1.1.2 文档预期读者 项目经理、

3、系统分析员、研发经理、测试经理、项目组长、系统开发人 员。 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 程序功能描述程序

4、功能描述 2.2.1 函数列表函数列表 成员类型成员类型成员说明 类内/外 部使用 public int AddDlog(string SQLstring) 将指定的日志 写入数据库 外 public int SGetLog(int logTime,int OState,out DataSet logDataSet) 服务器日志查询外 方法方法 private int ExecuteSelect(int time,int state,out DataSet logDataSet) 用语执行内嵌的 SWITCH 查询字符 串 内 2.2.2 函数功能说明函数功能说明 2.2.2.1 查询记录并得

5、到记录集查询记录并得到记录集 函数名： AddLog 函数定义：public int Addlog(string SQLstring) 访问权限：public 参数： 参数名类型说明 SQLstringstring执行操作的 SQL 语句 返回值类型：int 值说明 0插入成功 2.2.2.2 服务器日志查询服务器日志查询 函数名： SGetLog 函数定义：public int SGetLog(int logTime,int OState,out DataSet logDataSet) 访问权限：public 参数： 参数名类型说明 logTimeint查询时间(0 为所有时间,3 为 3

6、天 以内,7 为 7 天以内) OStateint操作状态(0 为成功,1 为失败,2 为 所有操作) logDataSetout DataSet 查询的输出型的记录集 返回值类型：int 值说明 0插入成功 2197服务器操作条件不符，操作失败 2.2.2.3 用于执行内嵌的用于执行内嵌的 SWITCHSWITCH 查询字符串查询字符串 函数名： ExecuteSelect 函数定义：private int ExecuteSelect(int time,int state,out DataSet logDataSet) 访问权限：public 参数： 参数名类型说明 timeint查询时间(0 为所有时间,3 为 3 天 以内,7 为 7 天以内) stateint操作状态(0 为成功,1 为失败,2 为 所有操作) logDataSetout DataSet 查询的输出型的记录集 返回值类型：int 值说明 0插入成功 2197服务器操作条件不符，操作失败 2.3 注释设计注释设计 在方法的前面标注注释，描述该方法的功能，参数类型，返回值。 声明变量应标注该变量的用途。 在判断错误的位置加注释，说明是什么错误。 2.4