5.2命名的规范.doc

软件设计规范前 言 本文定义了组织中书写文档及常用编程语言的编码风格的格式要求及规范要求，以达到风格的统一。 文档可使用文档模版，具体编码格式需要根据不同的语言和编译器进行适度裁剪。 目前文档中没有列到的语言，在项目需要时，要及时制定，评审通过后，及时充实到文档中。 目 录 第一章 简介 6 1.1 目的 6 1.2 文档结构 6 1.3 引用文件 6 1.4 术语表 6 1.5 参考资料 6 第二章 体系结构设计原则 7 2.1 合适性 7 2.2 结构稳定性 7 2.3 可扩展性 7 2.4 可复用性 7 第三章 用户界面设计 8 3.1 前言 8 3.2 共性规则 8 3.2.1 缩进 8 3.2.2 边距 8 3.2.3 结束标志 8 3.2.4 注释 9 3.2.5 文件头部 9 3.3 命名规范 9 3.3.1 总则 9 3.3.2 过程与函数 10 3.3.3 变量（Variable） 10 3.3.4 常量 10 3.3.5 大小限制 10 第四章 界面设计标准 11 4.1 前言 11 4.2 易用性 11 4.3 规范性 11 4.4 帮助设施 12 4.5 合理性 13 4.6 美观与协调性 14 4.7 菜单位置 14 4.8 独特性 15 4.9 快捷方式的组合 15 4.10 安全性考虑 16 4.11 多窗口的应用与系统资源 17 4.12 BS程序标准 17 第五章 数据库设计标准 18 5.1 前言 18 5.2 命名的规范 18 5.2.1 数据库命名规范 18 5.2.2 表及表空间命名规范 18 5.2.3 字段命名规范 18 5.2.4 存储过程编写规范 19 5.2.5 函数编写规范 19 5.2.6 触发器编写规范 20 5.3 SQL编码规范 20 5.3.1 参数规范 20 5.3.2 变量命名规范 21 5.4 游标（Cursor）的慎用 21 5.5 索引(Index)的使用原则 22 5.6 数据的一致性和完整性 23 5.7 事务的陷阱 23 5.8 数据库性能调整 23 5.9 数据类型的选择 24 第六章 模块设计 25 6.1 信息隐藏 25 6.2 高内聚 25 6.3 低耦合 26 第七章 数据结构与算法设计 27 第八章 类和接口设计原则 28 简介 目的 本文的目的是建立组织中书写文档及编码有关的格式要求及规范要求。 文档结构 无。 引用文件 无。 术语表 无。 参考资料 Paulk, Mark C., et al. Capability Maturity Model for Software, Version 1.1 CMU/SEI-93-TR-24 Paulk, Mark C., et al. Key Practices of the Capability Maturity Model,Version 1.1, CMU/SEI-93-TR-25  体系结构设计原则 合适性 即体系结构是否适合于软件的“功能性需求”和“非功能性需求”。高水平的设计师高就高在“设计出恰好满足客户需求的软件，并且使开发方和客户方获取最大的利益，而不是不惜代价设计出最先进的软件。 结构稳定性 详细设计阶段的工作如用户界面设计、数据库设计、模块设计、数据结构与算法设计等等，都是在体系结构确定之后开展的，而编程和测试则是更后面的工作，因此体系结构应在一定的时间内保持稳定。 软件开发最怕的就是需求变化，但“需求会发生变化”是个无法逃避的现实。人们希望在需求发生变化时，最好只对软件做些皮毛的修改，可千万别改动软件的体系结构。如果当需求发生变化时，程序员不得不去修改软件的体系结构，那么这个软件的系统设计是失败的。 高水平的设计师应当能够分析需求文档，判断出哪些需求是稳定不变的，哪些需求是可能变动的。于是根据那些稳定不变的需求设计体系结构，而根据那些可变的需求设计软件的“可扩展性”。 可扩展性 可扩展性是指软件扩展新功能的容易程度。可扩展性越好，表示软件适应“变化”的能力越强。 可扩展性越来越重要，这是由现代软件的商业模式决定的： 社会的商业越发达，需求变化就越快。需求变化必将导致修改（或者扩展）软件的功能，现代软件的规模和复杂性要比十年前的大得多（对比一下操作系统的变化就明白了），如果软件的可扩展性比较差的话，那么修改（或者扩展）功能的代价会很高。 现代软件产品通常采用“增量开发模式”，开发商不断地推出软件产品的新版本，从而不断地获取增值利润。如果软件的可扩展性比较差的话，每次开发新版本的代价就会很高。虽然开发商抓住了商机，但却由于设计水平差而导致没有赚取多少利润，真是要活活气死。 可复用性 由经验可知，通常在一个新系统中，大部分的内容是成熟的，只有小部分内容是创新