文档介绍：软件详细设计说明书xxx项目详细设计说明书(xxx模块)拟制日期yyyy-mm-dd评审人日期批准日期签发日期文档修订记录版本完*** (可选) (可选) #/触发器#的名称 10表目录表1. 关键词 4表2. 类XXX的属性 5表3. 方法描述xxx-function 6图目录图1 类图xxx-class 5图2 流程图xxx-function 6简介编写目的这部分要描述文档的目的,并指明文档的读者。适用范围软件名称软件功能解释软件产品将完成或不完成的功能软件应用描述软件的应用领域定义及关键词关键词关键词英文全名中文解释参考资料子模块1设计描述类xxx的设计简介如果在概要设计中未说明,则在此详细描述类的职责和功能,可使用顺序图、协作图、状态图来详细描述。必要时,可描述本类与相关类之间的静态动态关系。类图类图xxx-class状态设计(可选)可以用状态图来描述类的状态信息。属性可先定义相关的数据结构,再对属性进行描述。也可以不使用表格、而使用伪代码格式。类XXX的属性可见性属性名称类型说明(对属性的简短描述)PrivatePublicProtected方法方法xxx方法描述Java的函数头注释采用JavaDoc自动生成的格式:/******@functions增删改查XXX****@paramStringname名字****@returntrue如果不为空则返回真,false如果为空返回假****@throws无*/C++使用以下格式:方法描述xxx-function函数原型方法的声明,包含可见性功能描述描述本方法的功能被调函数被本函数调用的函数清单(非系统函数)主调函数调用本函数的函数清单(非系统函数),可选输入参数描述每个输入参数的含义、内存管理原则(谁分配、谁释放)输出参数描述每个输出参数的含义、内存管理原则(谁分配、谁释放)返回值描述返回值的含义抛出异常描述可能抛出的异常实现描述(使用伪代码、流程图等来描述本方法的详细实现。这部分是详细设计的重点。可以在开发工具中编写后再将文件嵌入到文档中。伪代码请直接写成注释格式,减少编码阶段的注释工作量)