文档介绍：三、设计规格说明书
完成人
完成任务
数据结构设计
体系结构设计
子系统清单
模块设计
功能模块清单
引言
(Introduction)
(Purpose)
软件设计的目标和任务是将软件需求变换成为软件的具体设计方案。根据用信息域表示的软件需求,以及功能和性能需求,进行数据设计、系统设计和过程设计。数据设计侧重于数据结构的定义;系统结构设计是定义软件系统个主要成分之间的关系;过程设计则是把结构成份转换成软件的过程性描述,在编码步骤,根据这种过程性描述,生成源程序代码,然后通过测试最终得到完整有效的软件。详细设计需要给出软件模块的内部过程描述。本文档是针对所有的开发人员、项目经理、测试人员编写的文档,对软件设计结果进行了详细的描述,同时也是程序员编写程序的功能依据。
(Naming Rule)
控件命名:[1] 按钮 btn+“(首字母大写)”如:btnOK, btnSubmit, btnReset……
[2] 文本框 txt+“(首字母大写) ”如:txtName,txtID……
[3] 静态文本框 lab+“(首字母大写)”如:labName……
[4] 其他控件不做具体要求,形式如上更好……
注释规范:[1] 注释要写在方法名、类名、接口类名前
[2] 避免杂乱注释,如一整行星号,可用空行代替
[3] 多行注释用“/*……*/”
变量命名
规范:[1] 类模块级变量用“m_“做前缀”_“后第一个字母要大写。如: String m_Name; String m_Date
[2] 过程级变量不使用前缀,但首字母大写如:String Word;
[3] 过程参数使用“P_”做前缀如:void Say(String P_Word)
方法函数
命名规范:用动词或动词短语命名方法,单词首字母均大写如:
RemoveAll();GetCharArray();Invoke()
类命名规:[1] 类名单词首字母大写 class FileStream { }
[2] 用名词或名词短语命名类 class Button{ } ;class Area{ }
[3] 使用全称,避免用缩写除非已经公认的缩写如:URL,HTML
(Terms Glossary)
术语定义或解释一般用表格形式给出,如表3-1所示。
表4-1-1 术语定义表
序号
术语名称
术语定义
1
总体结构
软件系统的总体逻辑结构。按照不同的设计方法,有不同的总体逻辑结构。若采用面向功能或面向数据的设计方法,总体逻辑结构一般为树形的功能模块结构图。若采用面向对象或面向部件(构件)的设计方法,则总体逻辑结构一般为为部件(构件)的组装图。所以根据设计的方法不同,会有不同的结构图或者功能模块,本系统是采用的面向对象和面向功能的设计方法,我们用了4+1视图方法来描述系统的设计功能。
2
外部接口
外部借口就是软件系统与其他软件或者系统的通讯借口,主要是之间进行传输数据等功能。本软件系统与其他软件系统之间的接口,接口设施可以是中间件。接口描述包括:传输方式、带宽、数据结构、传输频率、传输量、传输协议等。
3
数据结构
数据结构包括:数据库表的结构、其他数据结构等
4
角色
数据库中享有某些特权操作的用户,叫做角色。角色的权利一般通过授权来实现的,赋予角色什么样的权利,角色只能在授权范围内进行相应的操作,比如:浏览、登录、留言等功能。
5
子系统
具有相对独立功能的小系统叫做子系统。一个大的软件系统可以划分为多个子系统,每个子系统可由多个模块或多个部件组成,每个子系统或者模块都可以单独行使自己的功能,许多个子系统一起组成大的软件,相对独立又相互联系。
6
模块
具有功能独立、能被调用的信息单元叫做模块。模块是结构化设计中的概念,在程序设计中,为完成某一功能所需的一段程序或子程序;或指能由编译程序、装配程序等处理的独立程序单位;或指大型软件系统的一部分。
7
内部接口
软件系统内部各子系统之间、各部件之间、各模板之间的接口,叫做内部接口。接口描述包括:调用方式、入口信息、出口信息等。
8
相关文件
相关文件是指当本文件内容变更后,可能会引起变更的其他文件。如需求分析报告、详细设计说明书、测试计划、用户手册
9
参考资料
参考资料是指本文件书写时用到的其他资料。如各种有关规范、模板、标准、准则等。
(References)
[1] 设计规格说明
[2] 用户需求报告
[3] 系统设计规范
[4] 数据设计规范
[5] 数据库设计规范
[6] 命名规范
(Relat