信息系统中的标准化和规范化设计：提高软件开发质量的关键！

一个大的信息系统往往具有多个子系统，因为开发的工作量大，可能会有多个程序员参与开发，这里要求进行的标准化和规范化的设计，主要是规范开发人员的开发行为，避免一人一个样、多人多个样、五花八门、软件不统一和不一致等问题的出现。

例如，笔者在1999年为某施工企业开发信息系统时就进行了以下标准化和规范化的设计。

1.有关数据库命名的规范

（1）数据库名称：misweb_qh。

（2）自定义表的命名规则。

格式：模块简写_单词1_单词2_单词3

例如：HT_QXGL_ZHSZ代表合同管理模块_权限管理_组号设置

（3）列（字段）的命名规则。

多数字段采用中文命名；

每表有一个ID字段，Int（4），设置为标识字段；

每表增加一个“数据上传”字段，“SmallDatatime”数据类型；

多数表增加“备注”字段；

不好确定长度的字符型字段尽量定义为“VarChar”类型，长度可大一点，留有余地。

（4）视图的命名。

V_单词1_单词2_单词3

（5）索引的命名。

IND_单词1_单词2_单词3

2.有关函数、变量定义的规范

（1）函数定义。函数的定义应使用完整的英文单词组合来表明函数的含义，每个单词的首字母要大写。

例：GetDimensions（ ）

OnNewDocument( )

如用单词全拼太长时，可以使用缩写，但应尽量不用。用时应首先考虑少用单词，而不是把所有单词均缩写；有些情况下，用缩写符合惯例的，就用缩写。

例：OnUpdateDataFormatSelection（ ）如嫌太长，可以写成OnUpdateSelection（ ），而不要写成类似OnUpDataForSele（ ）的形式，太难懂。

（2）变量定义。变量的基本组成使用英文。

用小写字母的前缀表示变量的类型，前缀的下一个字母用大写，单词的首字母用大写。

全局变量定义时加g_，如g_bFlag，编程时尽量不要使用全局变量。

很简单或某个很小的局部变量，使用时可不加类型，如m_play，i，n等。

3.有关程序注释的规范

注释一律使用中文。

（1）文件头部的注释：在自编文件的头部，应加注释。格式如下：

/////////////////////////////////////////////////////////////////

// 程序功能：实现数据的录入

// 编程人员：樊建平

// 最后修改：1999-12-28

// 程序重点描述：

/////////////////////////////////////////////////////////////////

（2）函数头部的注释：在函数的前一行，应加注释，说明函数的功能。格式如下：

//完成数据的读入(www.xing528.com)

//最后修改：1999-12-14

（3）函数内的注释：如有必要，在函数中的重要模块头部或条件判断处，应加注释。如在某模块的前一行加注释，说明模块的功能；在条件判断的前一行或同行右侧加注释，说明判断条件和分支走向。举例如下：

//写数据

// 如果文件已经打开

……

//如果文件没打开

……

（4）对变量、函数定义的注释：在.pas文件中定义的临时变量，也要在同行右侧，给出该变量的注释。

（5）重要修改处的注释：在重要的修改处，应注明修改人和修改时间，格式如下：

// 以下代码（到函数末），由樊建平修改，主要加了文件已打开的判断条件。

4.有关程序设计和编程风格的规范

（1）程序单元。

·程序单元的命名、窗体的命名可使用默认值。

·窗体中对象的命名可使用默认值。

·程序应严格采用梯形层次对应好各层次。

·模块和模块之间，或不同的功能块之间，应用一个或两个空行隔开。

（2）对话框。

·尽量不要使用非模式对话框。

·对话框字体使用system，10。

·对话框中同类的项应放在一个Group Box中。

（3）菜单、工具条、目录树。

重点参考通用合同管理系统，但要注意：目录树与窗口之间使用橡皮筋分隔，可左右拖动。

（4）界面风格。

·系统分辨率为800×600，但在1024×768的屏幕上，能自动适应或居中显示。

·窗口在程序运行时应最大化生成，可以关闭最小化功能。

·窗口最上方为标题栏；标题下面是菜单栏；菜单栏下面是工具栏；窗口最下方为状态栏。

·消息由消息框弹出，消息框应尽量使用系统消息对话框。

·界面配色应使得整个程序显得朴素大方、简洁明快。界面的主要色调为：白色、灰色、浅绿、蓝色等，以淡色为主。可以参考如新浪、搜狐、Tom以及一些卖花的网站的配色。

（5）异常处理。

程序应提供异常处理能力，在异常出现时能够将控制转移到异常处理程序段，保证程序能够层层退出。

（6）程序多余。

·没有不可能执行到的代码。

·没有是否执行均不对程序功能产生影响的指令。

·没有未被引用的变量、标号和常量。

（7）其他。

·备注：有疑问的地方用红色显示，供大家讨论决定，以后每周举行一次讨论会，专门讨论疑难问题。

·注册表信息：写入注册表时采用统一名称misweb_qh。