软件详细设计说明模板-类设计版

1、软件详细设计说明V4.0-2XX-XXX-XX标记数量修改单号签字日期编制XXXX会签软件详细设计说明校对XXXX标检XXXX共9页第1页审核批准XXXX中国船舶工业系统工程研究院会签XXXXGr002.6C软件详细设计说明修订记录版本号修订状态简要说明修订内容和范围修订日期修订人批准日期注：修订记录在体系文件发布后换版时使用，修订状态栏填写：A一增加，M卜修改,5目次1范围21.1 标识21.2 系统概述21.3 文档概述22引用文档23 CSCI详细设计 23.1 类的唯一标识（XX类）33.1.1 类说明33.1.2 类数据33.1.3 类操作33.2 数据库表设计（可选）54需求可追踪

2、性55注释5图序图1 XX操作活动图4表序表1类列表2表2类变量/数据说明表3表3类操作描述表3表4所用算法4表5 函数描述表4表6 数据库表结构 5表7需求追踪表（正向）5表8需求追踪表（逆向）5Gr002.6C软件详细设计说明1范围1.1 标识本条应描述本文档所适用系统和软件的完整标识，适用时，包括其标识号、名 称、缩略名、版本号和发布号。简要说明软件的标识号、发布号、名称、缩略名、版本号。a）软件标识号：b） 发布号：V01c）名称：d）缩略名：e） 版本号：V1.01.2 系统概述本条应概述本文档所适用系统和软件的用途。分别简要说明系统的用途、软件用途标识需方、用户、开发方等。a） 需

3、方：b）用户：c）开发方：1.3 文档概述本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求。2引用文档本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能 通过正常采购活动得到的文档的来源。示例：a）文档名称1，编号（若有），编写单位，版本（若有），日期；b）文档名称2，编号（若有），编写单位，版本（若有），日期。3 CSCI详细设计本文档详细描述的类列表如表1所示。表1类列表序号类标识类名称备注1.2.3.4.注释：1 .软件项目负责人根据项目实际情况，选择主要的类进行详细描述。类列表中的类需进行跟踪。2 .该列表中至少包含概要设计中的类3.1 类的唯一标

4、识（XX类）3.1.1 类说明给出该类的简要描述。3.1.2 类数据对类变量/数据进行说明。表2类变量/数据说明表数据名称标识可见性数据类型数据说明发送业务信 息界面m_form_sendInfoprivate3.1.3 类操作描述类的具体操作函数，对函数输入输出参数进行说明，对函数处理过程可以 采用活动图的方式进行描述。表3类操作描述表序号操作标识操作名称可见性功能描述5.Init_Ywxx_Interface初始化业务信息查询 界面private显示业务信息查询界面控件6.7.8.注释：使用者可以根据习惯选择使用3.1.3.1章节形式（建议逻辑流程复杂，活动图 较多时使用）或者3.1.3.

5、2 章节表格形式（建议逻辑流程简单，活动图较少或者不 需要使用活动图描述时使用）对类的操作进行描述。3.1.3.1 操作标识（操作名称）a）数据元素对该操作所用到的数据元素进行定义。如此内容已在前面描述可在此引用或省 略。b）逻辑流程以活动图的形式对该操作的顺序、动态控制序列，异常与错误处理等内容进行 描述。5图1 XX操作活动图C）所用算法d）其它设计如有需要，给出类设计中的约束、限制或非常规特征；要使用的规定CSCI语言之外的编程语言和它的使用原理等。3.1.3.2表5 函数描述表函数定义返回值函数名称（参数）所属接口名称接口标识简单描述描述一下这个函数的功能和作用。名称in/out简短描

6、述参数说明参数名 称填 in 入） 者（ 出）写 （输 或out 输描述参数的相关说明，可以包括数据值的有效范 围，输出的形式、数量和频度，输出媒体、对输 出图形及符号的说明、安全保密条件等等。若是 数据结构类型，则在 4.1.6中描述。返回值示例：true:配置站位成功；false:配置站位失败。逻辑流程 （可选）以活动图的形式对该操作的顺序、动态控制序列，异常与错误处理等内容进 行描述。算法描述对使用的算法进行简单描述，包括输入、输出及算法本身。其它设计如有需要，给出类设计中的约束、限制或非常规特征；要使用的规定CSCI语言之外的编程语言和它的使用原理等。3.2 数据库表设计（可选）若是有数据库设计说明或者在概要设计文档中已说明，则本节可选。示例:表6数据库表结构序 号字段名称字段标识字段类型长度主键外键非空注释1是/否是/否是/否默认值等24需求可追踪性表7 需求追踪表（正向）软件详细设计说明软件概要设计说明类标识/名称章条号包标识/名称章条号XX3.2.1XX