10
第3页共10页
f详细设计说明书
表目录
表1表2表3
关键词5类XXX的属性6方法描述xxxfu
ctio
7
图目录
图1类图xxxclass6图2流程图xxxfu
ctio
7
第4页共10页
f1简介
11编写目的
这部分要描述文档的目的，并指明文档的读者。
12适用范围121软件名称
122软件功能
解释软件产品将完成或不完成的功能
123软件应用
描述软件的应用领域
13定义及关键词
关键词
表1关键词
英文全名
详细设计说明书
中文解释
14参考资料
1
第5页共10页
f详细设计说明书
2子模块1设计描述
21类xxx的设计211简介
如果在概要设计中未说明，则在此详细描述类的职责和功能，可使用顺序图、协作图、状态图来详细描述。必要时，可描述本类与相关类之间的静态动态关系。
212类图
图1类图xxxclass
213状态设计（可选）
可以用状态图来描述类的状态信息。
214属性
可先定义相关的数据结构，再对属性进行描述。
也可以不使用表格、而使用伪代码格式。
表2类XXX的属性
可见性PrivatePublicProtected
属性名称
类型
说明（对属性的简短描述）
215方法1方法xxx
1方法描述
Java的函数头注释采用JavaDoc自动生成的格式：fu
ctio
s增删改查XXXparamStri
g
ame名字retur
true如果不为空则返回真，false如果为空返回假throws无
C使用以下格式：
第6页共10页
f详细设计说明书
函数原型功能描述被调函数主调函数输入参数输出参数返回值抛出异常
表3方法描述xxxfu
ctio
方法的声明，包含可见性描述本方法的功能被本函数调用的函数清单（非系统函数）调用本函数的函数清单（非系统函数）可选描述每个输入参数的含义、内存管理原则（谁分配、谁释放）描述每个输出参数的含义、内存管理原则（谁分配、谁释放）描述返回值的含义描述可能抛出的异常
2实现描述
（使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。可以在开发工具中编写r