1引言 ............................................................................................................................................... 2 1.1编写目的 ................................................................................................................................. 2 1.2背景......................................................................................................................................... 2 1.3定义......................................................................................................................................... 2 1.4参考资料 ................................................................................................................................. 2 2程序系统的结构 ........................................................................................................................... 2 3程序1(标识符)设计说明......................................................................................................... 3 3.1程序描述 ................................................................................................................................. 3 3.2功能......................................................................................................................................... 4 3.3性能......................................................................................................................................... 4 3.4输人项..................................................................................................................................... 4 3.5输出项..................................................................................................................................... 4 3.6算法......................................................................................................................................... 4 3.7流程逻辑 ................................................................................................................................. 4 3.8接口......................................................................................................................................... 5 3.9存储分配 ................................................................................................................................. 7 3.10注释设计 ............................................................................................................................... 7 3.11限制条件 ............................................................................................................................... 7 3.12测试计划 ............................................................................................................................... 7 3.13尚未解决的问题 ................................................................................................................... 8 4程序2(标识符)设计说明....................................................................... 错误!未定义书签。
详细设计说明书
1引言
1.1编写目的
该文档主要是对值班管理在编写代码中所涉及的组件,以及组件之间的关系,该文档的编写作为软件开发、项目管理、编写用户手册提供了依据
1.2背景
说明:
a. 系统的名称:会议管理 b. 编写者: 陈平
1.3定义
值班安排管理员:对值班安排进行管理, 包括设置、删除值班安排。另外包括对值班日志的管理。
值班人员:添加当日值班日志。可以浏览咨询问题。
1.4参考资料
列出有关的参考资料,如:
a. 卫生局OA系统需求规格说明书.doc
b. 卫生局OA系统中会议管理的界面原型。
2程序系统的结构
用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间 的层次结构关系。
3值班管理设计说明
3.1程序描述
值班管理人员主要对值班人员进行登记、删除、修改操作。另外值班人员可以记录当日的值班日志事件,浏览咨询问题。其他用户都可以浏览、查询值班安排信息。
3.3性能 3.4输人项
无
3.5输出项
无
3.6算法
无
3.7流程逻辑
无
(1) 包名: org.duty.
(2) 控制类中的参数赋值和调用方式,如下: public class FAQ{ /**
* 在咨询问题中添加一条记录
* @param FAQinfo faqinfo 咨询问题的基本信息 * @return 返回关键字pk的值 * @throws Exception */
public String append(FAQinfo faqinfo) throws Exception;
/**
* 根据咨询问题的id,对咨询问题信息进行修改 * @param FAQinfo faqinfo 会议室的基本信息 * @throws Exception */
public void modify(FAQinfo faqinfo) throws Exception;
/**
* 根据咨询问题的id,删除该条咨询问题 * @param String id 咨询问题的id * @throws Exception */
public void delete(FAQinfo faqinfo) throws Exception; /**
* 根据咨询的id,查询出该条咨询问题的基本信息 * @param String id 会议室的id号 * @return FAQinfo 会议室的信息 * @throws Exception */
public FAQinfo search(String id) throws Exception;
/**
* 根据查询出所有的咨询问题的信息
* @return List 存储的是FAQinfo,即会议室的信息 * @throws Exception */
public List browser ( ) throws Exception; }
3.9存储分配
根据需要,说明本程序的存储分配。
3.10注释设计
程序的注释主要有下面几中,如: a. 加在模块首部的注释;如: /**
* <p>Title: </p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2004</p> * <p>Company: </p> * @author * @version 1.0 */
b. 在函数的前面加上对函数的说明,主要是:
①.对函数的功能的描述, ②.对各个参数的说明。 ③.对返回值的说明。 ④.对异常的说明.
c. 对使用的逻辑所加的注释。
3.11限制条件
能对值班安排信息、咨询问题和值班日志进行管理的只有值班管理员,值班员只能浏览查询信息,以及在值班日志中添加值班事件。
3.12测试计划
无
3.13尚未解决的问题
无