文档介绍：Document number【AA80KGB-AA98YT-AAT8CB-2A6UT-A18GG】
软件详细设计说明书
xxx项目详细设计说明书
（xxx模块）
拟制
日期
yyyy-mm-dd
Document number【AA80KGB-AA98YT-AAT8CB-2A6UT-A18GG】
软件详细设计说明书
xxx项目详细设计说明书
（xxx模块）
拟制
日期
yyyy-mm-dd
评审人
日期
批准
日期
签发
日期
文档修订记录
版本
完***
修改内容
审核
批准
时间

创建文档
目录
1. 简介 5
. 编写目的 5
. 适用范围 5
软件名称 5
软件功能 5
软件应用 5
. 定义及关键词 5
. 参考资料 5
2. 子模块1设计描述 6
. 类xxx的设计 6
简介 6
类图 6
状态设计（可选） 6
属性 6
方法 6
3. 数据库详细设计（可选） 9
. 存储过程#/触发器#的名称 9
4. 错误处理 10
. 系统错误 10
. 接口错误 10
. 协议错误 10
表目录
表1. 关键词 4
表2. 类XXX的属性 5
表3. 方法描述xxx-function 6
图目录
图1 类图xxx-class 5
图2 流程图xxx-function 6
简介
编写目的
这部分要描述文档的目的，并指明文档的读者。
适用范围
软件名称
软件功能
解释软件产品将完成或不完成的功能
软件应用
描述软件的应用领域
定义及关键词
关键词
关键词
英文全名
中文解释
参考资料
子模块1设计描述
类xxx的设计
简介
如果在概要设计中未说明，则在此详细描述类的职责和功能，可使用顺序图、协作图、状态图来详细描述。必要时，可描述本类与相关类之间的静态动态关系。
类图
类图xxx-class
状态设计（可选）
可以用状态图来描述类的状态信息。
属性
可先定义相关的数据结构，再对属性进行描述。
也可以不使用表格、而使用伪代码格式。
类XXX的属性
可见性
属性名称
类型
说明（对属性的简短描述）
Private
Public
Protected
方法
方法xxx
方法描述
Java的函数头注释采用JavaDoc自动生成的格式：
/**
* ***@functions 增删改查XXX
* ***@param String name 名字
* ***@return true 如果不为空则返回真，false 如果为空返回假
* ***@throws 无
*/
C++使用以下格式：
方法描述xxx-function
函数原型
方法