详细设计说明书编写规范「建议收藏」

第1章 引言
　　1.1 目的
　　使项目详细设计说明书的编写规范化，从而规范软件管理。 尽可能详细地描述程序的各成份的设计考虑，以利于编制程序。
　　[此处加入编写目的]
　　1.2 背景
　　说明该软件系统名称，开发者，详细设计原则和方案
　　[此处加入项目背景资料]
　　1.3 参考资料
　　列出有关的参考资料名称，作者，发表日期，出版单位
　　[此处加入参考资料]
　　1.4 定义
　　列出本文件中专用的术语，定义和缩写词
　　[此处加入术语和缩写词]
　　第2章 程序系统的组织结构
　　2.1 运行环境(编程协定)
　　[此处加入运行环境]
　　2 .1.1 操作系统&数据库系统
　　列出系统运行的有关操作系统&数据库系统的名称，版本号，对应版权单位
　　[此处加入操作系统]
　　[此处加入数据库系统]
　　2 .1.2 编程工具
　　列出开发此系统的所需的主要编成工具的名称，版本号，对应版权单位,并简述其特点
　　[此处加入编程工具]
　　2 .1.3 编辑、调试、联接程序
　　[此处加入编辑、调试、联接程序]
　　2 .1.4 编译工具
　　[此处加入编译工具]
　　2 .1.5 模拟、仿真数据
　　模拟数据使用过去的真实数据，数据如下：
　　[此处加入数据]
　　过程如下：
　　[此处加入过程]
　　2 .1.6 诊断、测试程序
　　[此处加入诊断、测试程序]
　　2 .1.7 检测程序
　　[此处加入检测程序]

　　2.2 单元命名规则
　　[此处加入单元命名规则]

　　2.3 程序逻辑
　　用图表列出本程序系统内每个模块（或子程序）的名称，标识符，以及这些模块（或子程序）之间的层次关系
　　[此处加入程序逻辑]
　　第3章 单元设计说明
　　[此处加入单元设计说明]
　　3.1 模块单元（或子程序）（标识符）1（名称）
　　注明该功能模块的编号和模块名称
　　3 .1.1 程序描述
　　简要描述安排本模块（或子程序）的目的意义，程序的特点
　　[此处加入程序描述]
　　3 .1.2 功能
　　(1) 功能说明
　　详细描述此模块（子程序）完成的主要功能
　　[此处加入功能说明]
　　(2) 功能框图
　　[此处加入功能框图]
　　3 .1.3 输入项
　　描述每个输入项的特征，如：标识符，数据类型，数据格式，数值的有效范围，输入方式等
　　[此处加入输入项]
　　3 .1.4 输出项
　　描述每个输出项的特征，如：标识符，数据类型，数据格式，数值的有效范围，输出方式等
　　[此处加入输出项]
　　3 .1.5 算法
　　[此处加入算法]
　　3 .1.6 流程逻辑
　　[此处加入流程逻辑]
　　3 .1.7 接口
　　分别列出和本模块（子程序）有调用关系的所有模块（子程序）及其调用关系，说明与本模块（子程序）有关的数据结构
　　[此处加入接口]
　　3 .1.8 限制条件
　　说明本模块（子程序）运行中受到的限制条件
　　[此处加入限制条件]

　　3.2 模块单元（或子程序）（标识符）2（名称）
　　 ………
　　第4章 软件界面设计规范
　　说明：软件界面设计属于详细设计，设计人员可根据项目的规模及时间跨度来决定是否单列出来，可灵活掌握
　　4.1 编写目的
　　当今软件界的所有软件无不是可视化的用户界面，它的好处不外乎它有美观、直接、操作者易懂和操作方便等好处。（此处输入编写文档的具体目的）。
　　4.2 内容：
　　4 .2.1 界面设计思想
　　“为用户设计，而不是设计者”。
　　4 .2.2 界面设计原则
　　（1） 界面要美观、操作要方便并能高效率地完成工作。
　　（2） 界面要根据用户需求设计。
　　（3） 界面要根据不同用户的层次设计。（有的用户对计算机相当了解而有的从来就没碰过计算机）
　　（4） 避免出现嵌套式的界面设计。
　　（5） 界面和代码要相互制约。
　　（6） 界面要通“人性”。即要有引导用户操作的功能，不能是操作一有误就卡住什么都做不下去，又无任何提示来帮助用户如何进行操作。
　　4 .2.3 界面设计样式
　　(1) 登录界面
　　（此处加入登陆界面图）
　　（2）系统功能布局
　　菜单形式
　　（此处加入界面图）
　　标签栏形式
　　（此处加入界面图）
　　（3） 录入界面
　　（此处加入界面图）
　　（4） 查询界面
　　（此处加入界面图）
　　（5） 统计界面
　　（此处加入界面图）
　　4 .2.4 常见提示信息样式
　　（1） 当操作会带来严重后果时（默认按钮为“否“）
　　（此处加入界面图）
　　（2） 当操作会带来一定后果时（默认按钮为“否“）
　　（此处加入界面图）
　　（3） 当需征求操作者意愿时（默认按钮为“是“）
　　（此处加入界面图）
　　（4） 当需提供操作者帮助时
　　（此处加入界面图）
　　（5） 当操作者操作有错时
　　（此处加入界面图）
　　（6） 当是一般提示时
　　（此处加入界面图）
　　范例：
　　（此处加入界面图）
　　4 .2.5 常见错误信息样式
　　（此处加入界面图）
　　4 .2.6 其他界面约定
　　字体：一般界面字体为宋体，字号为9Twip（只要把窗体字体设为宋体，字号为9twip即可）。
　　颜色：界面颜色采用默认色（除非用户有特殊要求）。
　　按钮：高度375Twip，除“确定”和“取消”外都需含有快捷键。
　　常见按钮快捷键：添加(A)、删除(D)、查询(S)、更新(U)、打印(P)、关闭(C)、重新查询(R)、统计(T)、退出(E)。
　　数据：REAL型数据一律保留两位小数且右对齐。
　　对齐方式：界面上的标题（Label）右对齐，其他控件左对齐。

　　第5章 编码标准规范
　　5.1 编写目的：
　　使用统一编码约定集的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解这段编码。好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。
　　一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。编码约定的目的是使程序易于阅读和理解，而不是用过份的约束和绝对的限制来束缚程序员本身的创造性。
　　5.2 内容：
　　程序设计语言的特性和风格会直接影响到软件的质量和可维护性。
　　编码原则：
　　应尽量避免在系统初始化时运行过多的代码。（此处加入详细原则）
　　（1） 选用控制结构只准许一个入口和一个出口。
　　（2） 程序语句组成容易识别的块，每块只有一个入口和一个出口。
　　（3） 复杂的结构应该用基本控制结构进行组合嵌套来实现。
　　（4） 语句中没有的控制结构，可用一段等价的程序段模拟，但要求该程序段在整个系统应前后一致。
　　（5） 严格控制GOTO语句，仅在下列情形才可使用。
用一个非结构化的程序设计语言去实现一个结构化的构造。
在某种可以改善而不是损害程序可读性的情况下。

　　5 .2.1 对象命名约定
　　公式：对象名称=对象前缀+自定义名称（自定义名称要有一定的意义且第一个字母大写）
　　说明：如果是不需要对其编码的对象，那么对象名用默认对象名。
　　应该用一致的前缀来命名对象，使人们容易识别对象的类型。下面列出了 Delphi 支持的一些推荐使用的对象约定。
　　（1） 推荐使用的项目前缀

　　控件类型 前缀 例子
　　Class Module cmdl cmdlCheck
　　Data Environment dev devPrints
　　Data Report drt drtEnglish
　　Form frm frmEntry
　　MDIForm mfrm mfrmSinoexport
　　Module mdl mdlConnection
　　Project pjt pjtCkmis

　　（2）推荐使用的控件前缀
　　控件类型 前缀 例子
　　3D Panel pnl pnlGroup
　　ADO Data ado adoBiblio
　　Animated button ani aniMailBox
　　Check box chk chkReadOnly
　　Combo box drop-down list box cbo cboEnglish
　　Command button cmd cmdExit
　　Common dialog dlg dlgFileOpen
　　Communications com comFax
　　Control（当特定类型未知时，在过程中所使用的） ctr ctrCurrent
　　Data dat datBiblio
　　Data-bound combo box dbcbo dbcboLanguage
　　Data-bound grid dbgrd dbgrdQueryResult
　　xxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxx xxxxxxxx

　　（3）推荐使用的数据访问对象的前缀
　　用下列前缀来指示数据访问对象。
　　数据库对象 前缀 例子
　　Connection con conReports
　　xxx db dbAccounts

　　一些例子：
　　（此处加入例子）

　　（4）推荐使用的菜单前缀
　　应用程序频繁使用许多菜单控件，对于这些控件具备一组唯一的命名约定很实用。除了最前面 “mnu” 标记以外，菜单控件的前缀应该被扩展：对每一级嵌套增加一个附加前缀，将最终的菜单的标题放在名称字符串的最后。下表列出了一些例子。

　　菜单标题序列 菜单处理器名称
　　（此处加入标题序列及处理器名称）

　　当使用这种命名约定时，一个特定的菜单组的所有成员一个接一个地列在 Visual Basic 的“属性”窗口中。而且，菜单控件的名字清楚地表示出它们所属的菜单项。

　　（5）为其它控件选择前缀
　　对于上面没有列出的控件，应该用唯一的由两个或三个字符组成的前缀使它们标准化，以保持一致性。只有当需要澄清时，才使用多于三个字符的前缀。
　　例如，（此处加入例子）

　　5 .2.2 常量和变量命名约定
　　公式：常量或变量名称=常量或变量范围前缀+常量或变量类型前缀+自定义名称（自定义名称要有一定的意义且第一个字母大写）

　　除了对象之外，常量和变量也需要良好格式的命名约定。本节列出了（此处加入变量列表）。
　　变量应该总是被定义在尽可能小的范围内。全局 (Public) 变量可以导致极其复杂的状态机构，并且使一个应用程序的逻辑非常难于理解。全局变量也使代码的重用和维护更加困难。
　　Delphi中的变量可以有下列范围：
　　范围 声明位置 可见位置
　　过程级（此处加入名称）
　　模块级（此处加入名称）
　　全局（此处加入名称）。
　　较好的编码习惯是尽可能写模块化的代码。例如，如果应用程序显示一个对话框，就把要完成这一对话任务所需要的所有控件和代码放在单一的窗体中。这有助于将应用程序的代码组织在有用的组件中，并减小它运行时的开销。

　　除了全局变量（应该是不被传递的），过程和函数应该仅对传递给它们的对象操作。在过程中使用的全局变量应该在过程起始处的声明部分中标识出来。
　　变量范围前缀
　　随着工程大小的增长，划分变量范围的工作也迅速增加。在类型前缀的前面放置单字母范围前缀标明了这种增长，但变量名的长度并没有增加很多。

　　范围 前缀 例子
　　全局 g GstrUserName
　　模块级 m MblnCalcInProgress
　　本地到过程 无 DblVelocity

　　（此处加入说明）

　　变量
　　声明所有的变量将会（此处加入说明）。
　　应该给变量加前缀来指明它们的数据类型。而且前缀可以被扩展，用来指明变量范围，特别是对大型程序。

　　变量数据类型
　　用下列前缀来指明一个变量的数据类型。
　　（此处加入说明）
　　描述变量和过程名
　　变量或过程名的主体应该使用大小写混合形式，并且应该足够长以描述它的作用。而且，函数名（此处加入函数名称）。
　　对于频繁使用的或长的项，推荐使用标准缩略语以使名称的长度合理化。一般来说，（此处加入特例说明）就困难了。
　　当使用缩略语时，要确保它们在整个应用程序中的一致性。在一个工程中，如果一会儿使用（此处加入说明问题），将导致不必要的混淆。

　　用户定义的类型
　　在一项有许多用户定义类型的大工程中，常常有必要给每种类型一个它自己的三个字符的前缀。如果这些前缀是（此处加入前缀名称）。

　　5 .2.3 结构化编码约定
　　（此处加入约定说明）

　　记住下列几点：
　　每一个重要变量的声明应该包括（此处加入变量名称）。
　　（2）格式化代码
　　因为许多程序员（此处加入问题）

　　（此处加入解决问题的说明）
　　（3）给常量分组
　　变量和定义的常量应该按功能分组，而不是分散到单独区域或特定文件中。
　　（4）运算符
　　（此处加入运算符列表及说明）
　　（5）为（此处加入问题） 查询创建字符串
　　（此处加入说明）
　　5 .2.4 数据源的约定
　　（此处加入数据源的约定）
　　5 .2.5 数据库访问约定
　　访问数据库用ODBC drivers/ADO，但如果在有的技术ADO解决不了的情况下可用其他方法。
　　数据库访问技术有：（此处加入说明）
　　5 .2.6 其他约定
　　（1）当日期、时间型数据要求严格时，（此处加入说明）
　　 （2）记录集应用约束
　　（此处加入约束）
　　利用记录集
　　（此处加入记录集说明）
　　（3）文件命名约定
　　工程文件和各模块文件以汉字命名保存，这样可方便管理和查找。