详细设计说明书_v1.0范版

《详细设计说明书_v1.0范版》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、协同办公平台概要设计说明书内部文档协同办公系统详细设计说明书编写：****日期：2006-07-02审核：日期：批准：日期：受控状态：是发布版次：1.0日期：2006-07-02编号：XS1.0中软培训实训基地第11页共11页协同办公平台概要设计说明书内部文档变更记录日期版本变更说明作者2006-07-021.0初始版本王正韬、张敏签字确认系统模块对应章节对应部门负责人签字中软培训实训基地第11页共11页协同办公平台概要设计说明书内部文档目录1引言31.1编写目的31.2背景31.3基线31.4范围41.5定义41.6参考资料

2、42模块命名规则53模块汇总63.1模块汇总表63.2模块关系图74子系统模块设计74.1数据库连接模块74.2公司通讯录模块Address84.3在线信息模块Messages114.4名片夹模块Namecard154.5代办事项模块Notes204.6个人文件夹模块PersonalFile244.7日程模块Schedule304.8用户信息模块userInformation374.9系统管理模块systemManage411引言1.1编写目的本说明书目的在于明确说明系统各功能的实现方式，指导开发员进行编码。本说明书的预期读者

3、为：项目经理、+Teamgeist项目组开发人员1.2背景待开发软件系统的名称：协同办公系统此软件系统任务提出者：项目经理此软件系统任务开发者：***小组1.3基线协同办公平台需求分析说明书v1.1中软培训实训基地第11页共11页协同办公平台概要设计说明书内部文档1.1范围此说明书主要应用整个软件代码开发的生命周期以及测试周期1.2定义无1.3参考资料项目计划V1.2概要设计说明书V1.0中软培训实训基地第11页共11页协同办公平台概要设计说明书内部文档1模块命名规则标识符类型命名规则例子包（Packages）一个唯一包名的前

4、缀总是全部小写的ASCIIzimu并且是一个顶级域名，通常是com,edu,gov,mil,net,org,或1981年ISO3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department),项目（project），及其（machine），或注册名（loginname）。包括基本为全小写的字母com.sun.engcom.apple.quicktime.v2edu.com.cs.bovik.cheese类(Classes)

5、类名是一个单词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免错写词（除非该错写词被更广泛使用，像URL，HTML）classRaster;classImageSprite;借口（Interfaces）命名规则：大小写规则与类名相似interfaceRasterDelegate;interfaceStoring;方法（Methods）方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母音大写run();runFast();getBackground();

6、变量（Variables）除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或类元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i,j,k,m和n，它们一般用于整型；c，d，e，它们一般用于字符型。intI;floatmyWidth;实例变量(instanceVariables)大小写规则和变量名相似，处理前面需要一个下划线

7、int_employeeld;String_name;Customer_customer;常量（Constants）类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。（尽量避免ANSI常量，容易引起错误），使用staticfinal进行标明。staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=999;staticfinalintGET_THE_CPU=1;中软培训实训基地第11页共11页协同办公平台概要设计说明书内部文档1模块汇总1.1模块汇总表提示：这里模块是指相对

8、独立的软件设计单元，例如对象类、函数包等等。子系统Address公司通讯录模块名称功能简述公司通讯录通过人员姓名检索公司通讯录，通过公司组织树检索公司通讯录子系统Messages在线信息模块名称功能简述收件箱可以查询具体内容、删除信件发件箱可以查询具体内容、增加、删除、修改、