软件标准规范

案卷号

日期

数字音频信息系统(AudioMIS)

软件标准规范

作 者：

AudioMIS 项目开发小组

完成日期： 2004年10月10日

签 收 人：

签收日期：

修改情况记录：

版本号

修改批准人

修改人

安装日期

签收人

软件标准规范 .................................................................................................................................. 1

1 概念 .............................................................................................................................................. 1

1.1

编写目的 ................................................................................................................................ 1

1.2 参考资料 ........................................................................................................................... 1

2 程序文件................................................................................................................................... 1

2.1

2.2

2.3

3

项目文件的组织 ............................................................................................................... 1

常量定义 ........................................................................................................................... 3

结构类型定义 ................................................................................................................... 3

程序风格................................................................................................................................... 4

3.1

3.2

函数(FUNCTION)/过程(PROCEDURE)风格 ........................................................................ 4

语句风格 ........................................................................................................................... 5

3.2.1 变量定义语句 ....................................................................................................... 5

3.2.2 赋值语句 ............................................................................................................... 5

3.2.3 条件语句 ............................................................................................................... 6

3.2.4 循环语句 ............................................................................................................... 6

3.2.5 开关语句 ............................................................................................................... 7

3.3 注释行 ............................................................................................................................... 8

4 变量名命名规则....................................................................................................................... 8

4.1.1 简单变量命名 ....................................................................................................... 9

4.1.2 结构型变量命名 ................................................................................................. 11

4.1.3 复合变量命名 ..................................................................................................... 11

4.1.4 命名中限制的法则 ............................................................................................. 12

4.1.5 其它命名 ............................................................................................................. 12

4.2 文件及窗体命名 ............................................................................................................. 13

4.3 控件命名 ......................................................................................................................... 13

4.3.1 Standard 页控件 ................................................................................................. 13

4.3.2 Additional 页控件 .............................................................................................. 14

4.3.3 Win32 页控件 .................................................................................................... 15

4.3.4 System 页控件 ................................................................................................... 16

4.3.5 Internet 页控件 .................................................................................................. 17

4.3.6 Data Access 页控件 ........................................................................................... 19

4.3.7 Data Controls 页控件 ........................................................................................ 19

4.3.8 Midas 页控件 ..................................................................................................... 20

4.3.9 Decision Cube 页控件 ....................................................................................... 21

4.3.10 QReport 页控件 ................................................................................................. 22

4.3.11 Dialogs 页控件 .................................................................................................. 23

4.3.12 Win 3.1 页控件 .................................................................................................. 24

4.3.13 Samples 页控件 ................................................................................................. 25

4.3.14 ActiveX 页控件 ................................................................................................. 25

4.4 常用类的命名 ................................................................................................................. 26

5 应用程序的界面设计............................................................................................................. 27

5.1 概述 ................................................................................................................................. 27

5.1.1 目的 ................................................................................................................... 27

5.1.2 目标 ........................................................................................................................... 27

5.2 窗体/对话框设计 ............................................................................................................ 28

5.2.1 一般说明 ............................................................................................................. 28

5.2.2 消息对话框 ......................................................................................................... 28

5.2.3 窗体 ..................................................................................................................... 29

6

7

防错误处理............................................................................................................................. 33

框架和各个工具的接口 ......................................................................................................... 34

7.1

7.2

接口方式 ......................................................................................................................... 34

接口要求 ......................................................................................................................... 34

7.2.1 概述 ..................................................................................................................... 34

7.2.2 实现 ..................................................................................................................... 34

7.2.3 可预知的限制 ..................................................................................................... 34

8

9

版本号格式............................................................................................................................. 35

检查单 .................................................................................................................................... 35

数字音频信息管理系统(AudioMIS)——软件标准规范

软件标准规范

1 概念

1.1 编写目的

本规范规定了数字音频信息系统在编写过程中涉及到的程序文件和编码风格。本规范以

Delphi 语言为标准制定，使用其它编程语言的编码风格和规范在相关的文档中规定。

1.2 参考资料

程序员指南，Microsoft Press

Windows界面应用程序设计指南，Microsoft Press

Delphi 7 开发人员指南，机械工业出版社

程序设计规范VB，聂俊华，北航十四系

2 程序文件

2.1 项目文件的组织

在Delphi中，按照项目为单位来组织程序文件。在一个典型的项目中包括：

项目文件（.DRP文件）

含有工程主程序的Pascal源代码；

单元文件（.PAS文件）

项目中每个窗体的Pascal源文件，包含该窗体的所有声明和过程（包括时间处理过程）；

窗体文件（.DFM文件）

第1页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

含有一个窗体的设计属性的二进制文件，每个窗体的.DFM文件与.PAS文件相互对应；

资源文件(.RES文件)

编译的二进制资源文件，被链接到应用程序的可执行文件中；

项目选项文件(.DOF文件)

存储了Project|Options菜单命令所设置的项目选项；

桌面设置文件(.DSK文件)

存储了Tools|Options菜单命令所设置的桌面选项；

包文件(.DPK/.BPL文件)

用于共享组件、类、数据和代码的文件。源文件为.DPK文件，编译后为.BPL文件；

每个软件项目应使用独立的目录，软件项目下的不同类别文件、不同模块分设子目录。

以下给出软件项目及软件模块中，设置子目录名称的规范：

子目录 说明

Bin 建立产品的工作目录，存放项目中所有可执行文件的当前版本。

Lib 与项目有关的库文件。

Man 包括项目的所有外部文档。包括手册、帮助文件、其他在线文档、README文件以及其他将和产品一起发放到用户手中的文档。

SQL 存放数据库的SQL文件(只针对数据库程序的开发) 。

Res 包括应用程序的所有共享资源，如ICON(图表)、资源文件、Bitmap等。

Include 公用的窗体或Unit。

第2页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

Control 存放项目内用的自编或第三方提供的控件。

Source 程序源代码

Public 可以公用的模块或程序。

本规范在以下的各小节中具体说明Delphi 两种文件类型.PAS和.DFM在程序文件中的相关内容要求。

2.2 常量定义

内容：

逻辑值的定义；

常数值的定义；

错误码的定义；

格式：一个定义占一行。如下：

Const <常量> : 类型 = 值; //注释

说明：使用 Const 语句来声明用于代替文字值的常数。

示例：Const C_SQL:string='select CH_USERER_ID from T_CD_USER';

//查询用户ID

Const C_PI:real =3.1415926; //圆周率

2.3 结构类型定义

内容：结构类型定义

格式：

Type

第3页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

<类型名>

//结构说明注释

<变量名1> :

<变量名2> :

…

变量类型; //变量说明注释

变量类型; //变量说明注释

End ;

说明：

<类型名>是以大写字母开头的字符串。结构定义中定义变量类型的语句从第二行第五列开始。

示例：

type

TableList=record //系统树单元类型定义

InID : integer; //单元编号

Name : string; //单元名称

PID : string; //上一级单元名称

PT : PTableList; //指向下一单元类型的指针

end;

3 程序风格

程序风格规定了每个语句的定位规则及程序中的注释。

3.1 函数(Function)/过程(Procedure)风格

Name (变量 :变量类型[,…]); //函数/过程说明

第4页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

Var

变量1：变量类型；//变量说明

变量2：变量类型；//变量说明

…

Begin

语句;

语句;

……

End ;

注： 变量声明、语句均从第三列写起，如有缩进，每次缩进两列，并与相对应语句对齐。

3.2 语句风格

说明：

在程序体中通常最多每十行有一个段落功能说明；

规范使用各种语句；

语句中有缩进是以二列为单位。

3.2.1 变量定义语句

Var

var_name ： <数据类型>；

3.2.2 赋值语句

var_name: = <表达式>;

第5页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

3.2.3 条件语句

If 条件 Then //注释

Begin

语句;

…

End

//注释 ElseIf 条件 Then

Begin

语句;

...

End

Else

语句;

//注释

注：如果执行语句只有一句，可省略Begin、End语句。

3.2.4 循环语句

//循环功能注释

For counter: = start To end Do

Begin

[语句];

…

End;

第6页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

//循环功能注释

While [condition] Do

Begin

[语句];

…

End;

//循环功能注释

Repeat

[语句];

…

Until [condition]

3.2.5 开关语句

//开关功能说明

Case <表达示> Of

<值1>:[语句1];

<值2>:[语句2];

…

<值n>: [语句n]

End；

第7页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

3.3 注释行

在程序代码单元文件顶端必须拥有本单元文件“模块说明”及“单元说明”注释。对于常量、结构类型、函数/过程、自定义变量、代码段功能块、关键语句等有含义的代码部分，必须有注释行进行详细说明。

注释行可在需说明部分行后以“//XXXXXXXX”方式添加，也可在需说明部分行上以“{XXXXXXXXXX}”方式添加多行或以“//XXXXXX”方式添加一行。

4 变量名命名规则

命名包括对程序中文件、变量（包括控件等对象）、常量、过程和函数等程序对象的命名。

命名以匈牙利规则为参考，采用“限制 + 类型 + 名称”的命名方式。

限制是指变量与常量的区分和对作用域的确定，默认为变量和局部对象。对于常量要特别指出，对于非局部变量，要表明其使用范围，如全局或模块级。

类型以缩写表明该程序对象的类型，如32位有符号整数类型和列表框控件类型。

名称为对象的具体含义，要准确表达其用途，而不要使用与变量所代表的实体没有任何联系的名字，以英文、英文缩写组合给出；名称的书写采用大小写结合的方式，如CaseCount表示事件计数、DeleteUser表示删除人员等。

命名不宜过短，也不宜过长，除去限制和类型外，以8～15为好。过短的命名往往不能准确描述用意，如nCount命名含义太不明确，可以是雇员的计数，也可以是找到的文件的计数，而命名为nEmployeeCount和nFileCount将更有助于记忆和理解；过长的命名如recLoginUserInformation又显得冗长，改为recLoginUserInfor或recLoginUserInfo则会在不损失含义的情况下减少输入量，换言之，改动后的命名更合适。

命名中恰当使用反意词，可以提高可读性，下面是一些常用的容易理解的词对：

Add/Remove Begin/End Create/Destroy

第8页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

Insert/Delete First/Last Get/Release

Get/Set Get/Put Increment/Decrement

Lock/Unlock Min/Max Next/Previous

Next/Prior Old/New Open/Close

Show/Hide Source/Destination Source/Target

Start/Stop Write/Read

记住一些常见布尔型变量的命名，对规范化的实施也会有不少帮助，如Done、Error、Found、Success、Ready等

命名中的特例之一是单层循环的循环变量，使用i、j、k、l、m命名，简捷明快；当循环为多层时，各层的循环变量应尽可能命以有意义的名称，以避免使用时由于输入而产生的逻辑错误，尤其是在访问多维数组变量时，这种作法可以大大减少因数组下标指定失误引发的程序逻辑失败的机率，如将Cells[ i, j ]误作Cells[ j, i ]，而Cells[ nRow, nCol ]就不易误为Cells[ nCol, nRow ]。

以下定义Delphi 中的变量命名规则：

4.1.1 简单变量命名

类型 缩写 含义

Boolean b

Boolean变量

ByteBool bb

Boolean Byte变量

WordBool bw

Boolean Word变量

第9页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

LongBool bl

Boolean Long变量

Integer n

Number变量

ShortInt nt

Number Tiny变量

SmallInt ns

Number Short变量

LongInt nl

Number Long变量

Int64 ne

Number Extended变量

Comp ne

Number Extended变量

Byte unt

Unsigned Number Tiny变量

Word uns

Unsigned Number Short变量

LongWord unl

Unsigned Number Long变量

Real f

Float变量

Single fs

Float Single变量

Double fd

Float Double变量

Extended fe

Float Extended变量

Char c

Char变量

AnsiChar ca

Char Ansi变量

WideChar cw

Char Wide变量

第10页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

String s

String变量

ShortString ss

String Short变量

AnsiString sa

String Ansi变量

WideString sw

String Wide变量

Variant v

Variant变量

Enumerate e

Enumerate变量

Pointer p

Pointer变量

4.1.2 结构型变量命名

类型 缩写 含义

Array a Array

Set m Mass

Record r Record

Class o Object

4.1.3 复合变量命名

命名中有些缩写词是基础类型缩写，而另有一些是类型限定词，如u代表Unsigned和a代表Array。

整体缩写采用从右至左的分析方式，举例如下：

第11页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

Boolean数组命名为abXXXX

单精度附点数数组命名为afsXXXX

结构数组命名为arXXXX

枚举数组命名为aeXXXX

指针数组命名为apXXXX

字符集合命名为mcXXXX

32位整数集合数组命名为amnXXXX

结构指针命名为prXXXX

PChar命名为pszXXXX

PChar数组命名为apszXXXX

4.1.4 命名中限制的法则

全局冠以g_

模块级冠以m_

常量以C_开始

全局常量以gC_开头，模块级常量则mC_

4.1.5 其它命名

类型的命名采用Delphi通用的TXxxxYyyyZzzz形式

枚举型变量的元素命名为以小写的类型英文名字母缩写开始，如TFontStyle = ( fsBold,

fsItalic, ... )

类型常量命名为C_类型缩写_XxxxYyyy形式，无类型常量命名为C_含义或分组名_XxxxYyyy。其中XxxxYyyy要描述常量含义，可以归为一类的常量；有时Xxxx说明分组含义，而Yyyy为常量含义，如C_FontSizeBig = 20, C_FontSizeNormal = 12, C_FontSizeSmall =

第12页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

8。举例：C_as_FileNames : array[ 0..2 ] of string = ( ‘C:’,

‘C:’, ‘C: )和gC_MaxUsers = 500分别定义了“局部一维字符串数组常量”和“全局常数”。

4.2 文件及窗体命名

含义 类名 命名格式

工程文件

Program(.DPR) XXXX_P

单元

Unit(PAS) XXXX_U

窗体

(.DFM) XXXX_F

数据模块

DataModule XXXX_DM

4.3 控件命名

4.3.1 Standard 页控件

类名 命名格式

TMainMenu mmnuXXXX

TPopupMenu pmnuXXXX

TLabel lblXXXX

TEdit edtXXXX

第13页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

TMemo mmoXXXX

TButton btnXXXX

TCheckBox chkXXXX

TRadioButton rdbtXXXX

TListBox lbxXXXX

TComboBox cbxXXXX

TScrollBar scbrXXXX

TGroupBox gbxXXXX

TRadioGroup rgpXXXX

TPanel pnlXXXX

TActionList actsXXXX

4.3.2 Additional 页控件

类名 命名格式

TBitBtn btbtXXXX

TSpeedButton spbtXXXX

TMaskEdit medtXXXX

TStringGrid sgrdXXXX

第14页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

TDrawGrid dgrdXXXX

TImage imgsXXXX

TShape shpXXXX

TBevel bvlXXXX

TScrollBox scbxXXXX

TCheckListBox chksXXXX

TSplitter spltXXXX

TStaticText stxtXXXX

TControlBar ctbrXXXX

TChart chtXXXX

4.3.3 Win32 页控件

类名 命名格式

TTabControl tctlXXXX

TPageControl pctlXXXX

TImageList imgsXXXX

TRichEdit redtXXXX

TTrackBar tkbrXXXX

第15页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

TProgressBar pgbrXXXX

TUpDown updnXXXX

THotKey htkXXXX

TAnimate anmtXXXX

TDateTimePicker dtpXXXX

TMonthCalendar mcldXXXX

TTreeView tvwXXXX

TListView lvwXXXX

THeaderControl hctlXXXX

TStatusBar stbrXXXX

TToolBar tlbrXXXX

TCoolBar clbrXXXX

TPageScroller psclXXXX

4.3.4 System 页控件

类名 命名格式

TTimer tmrXXXX

TPaintBox ptbxXXXX

第16页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

TMediaPlayer mplrXXXX

TOLEContainer olectXXXX

TDDEClientConv ddeccXXXX

TDDEClientItem ddeciXXXX

TDDEServerConv ddescXXXX

TDDEServerItem ddesiXXXX

4.3.5 Internet 页控件

类名 命名格式

TClientSocket XxxxClientSocket

TServerSocket XxxxServerSocket

TWebDispatcher XxxxWebDispatcher

TPageProducer XxxxPageProducer

TQueryTableProducer XxxxQTProducer

TDataSetTableProceducer XxxxDSTProducer

TDataSetPageProceducer XxxxDSPProducer

TNMDayTime XxxxNMDayTime

TNMEcho XxxxNMEcho

第17页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

TNMFinger XxxxNMFinger

TNMFTP XxxxNMFTP

TNMHTTP XxxxNMHTTP

TNMMsg XxxxNMMsg

TNMMSGServ XxxxNMMsgServ

TNMNNTP XxxxNMNNTP

TNMPOP3 XxxxNMPOP3

TNMUUProcessor XxxxNMUUProcessor

TNMSMTP XxxxNMSMTP

TNMStrm XxxxNMStrm

TNMStrmServ XxxxNMStrmServ

TNMTime XxxxNMTime

TNMUDP XxxxNMUDP

TPowerSock XxxxPowerSock

TNMGeneralServer XxxxNMGeneralServer

THTML XxxxHTML

TNMURL XxxxNMURL

第18页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

4.3.6 Data Access 页控件

类名 命名格式

TDataSource dsXXXX

TTable tblXXXX

TQuery qryXXXX

TStoredProc sprcXXXX

TDatabase dbXXXX

TSession ssnXXXX

TBatchMove bmvXXXX

TUpdateSQL updtXXXX

TNestedTable ntblXXXX

4.3.7 Data Controls 页控件

类名 命名格式

TDBGrid dbgrdXXXX

TDBNavegator dbnvXXXX

TDBText dbtxtXXXX

第19页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

TDBEdit dbedtXXXX

TDBMemo dbmmoXXXX

TDBImage dbimgXXXX

TDBListBox dblbxXXXX

TDBComboBox dbcbxXXXX

TDBCheckBox dbchkXXXX

TDBRadioGroup dbrgpXXXX

TDBLookupListBox dbllbXXXX

TDBLookupComboBox dblcbXXXX

TDBRichEdit dbredXXXX

TDBCtrlGrid dbcgdXXXX

TDBChart dbchtXXXX

4.3.8 Midas 页控件

类名 命名格式

TClientDataSet cltdsXXXX

TDCOMConnection dcmcnXXXX

TCorbaConnection crbcnXXXX

第20页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

TSocketConnection sktcnXXXX

TOLEnterpriseConnection olecnXXXX

TDataSetProvider dsprdXXXX

TProvider prvdrXXXX

TSimpleObjectBroker sobkrXXXX

TRemoteServer rmtsvXXXX

TMidasConnection mdscnXXXX

4.3.9 Decision Cube 页控件

类名 命名格式

TDecisionCube dccbXXXX

TDecisionQuery dcqryXXXX

TDecisionSource dcsrXXXX

TDecisionPivot dcpvtXXXX

TDecisionGrid dcgrdXXXX

TDecisionGraph dcchtXXXX

第21页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

4.3.10 QReport 页控件

类名 命名格式

TQuickRep qrptXXXX

TQRSubDetail qrsdtXXXX

TQRStringsBand qrsbdXXXX

TQRBand qrbdXXXX

TQRChildBand qrcbdXXXX

TQRGroup qrgrpXXXX

TQRLabel qrlblXXXX

TQRDBText qrdbtXXXX

TQRExpr qrxprXXXX

TQRSysData qrsysXXXX

TQRMemo qrmmoXXXX

TQRExprMemo qrxpmXXXX

TQRRichEdit qrredXXXX

TQRDBRichEdit qrdbrXXXX

TQRShape qrshpXXXX

第22页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

TQRImage qrimgXXXX

TQRDBImage qrdbiXXXX

TQRCompositeReport qrcrpXXXX

TQRPreview qrprvXXXX

TQRTextFilter qrtflXXXX

TQRCSVFilter qrcsvXXXX

TQRHTMLFilter qrhtfXXXX

TQRChart qrchtXXXX

4.3.11 Dialogs 页控件

类名 命名格式

TOpenDialog opdgXXXX

TSaveDialog svdgXXXX

TOpenPictureDialog oppdgXXXX

TSavePictureDialog svpdgXXXX

TFontDialog ftdgXXXX

TColorDialog cldgXXXX

TPrintDialog prdgXXXX

第23页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

TPrinterSetupDialog psdgXXXX

TFindDialog fndgXXXX

TReplaceDialog rpdgXXXX

4.3.12 Win 3.1 页控件

类名 命名格式

TDBLookupList dbllsXXXX

TDBLookupCombo dblcbXXXX

TTabSet tbstXXXX

TOutLine otlnXXXX

TTabbedNoteBook tnbkXXXX

TNoteBook ntbkXXXX

THeader hdrXXXX

TFileListBox flbxXXXX

TDirectoryListBox dlbxXXXX

TDriveComboBox dcbxXXXX

TFilterComboBox fcbxXXXX

第24页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

4.3.13 Samples 页控件

类名 命名格式

TGauge ggeXXXX

TColorGrid clgrdXXXX

TSpinButton spnbtXXXX

TSpinEdit spedtXXXX

TDirectoryOutline dirolXXXX

TCalendar cldrXXXX

TIBEventAlerter ibaltXXXX

4.3.14 ActiveX 页控件

类名 命名格式

TChartFX chtfxXXXX

TVSSpell vssplXXXX

TF1Book bkf1XXXX

TVtChart vtchtXXXX

TGraph grphXXXX

注：1.可只对进行编码的控件命名，如果某控件只用做显示，如TLabel，则可采用Delphi自第25页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

动生成的名字Lable1；

2.若使用第三方控件或自定义类型控件，命名规则应以以上规则为参考。

4.4 常用类的命名

类名 命名格式

TObject objXXXX

TPersistent psstXXXX

TComponent cmptXXXX

TControl ctrlXXXX

TWinControl wctlXXXX

TForm frmXXXX

TList listXXXX

TStringList slstXXXX

TmenuItem miXXXX

TlistItem liXXXX

TtreeNodes tndsXXXX

TtreeNode tndXXXX

变量范围前缀

第26页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

随着工程大小的增长，划分变量范围的工作也迅速增加。在类型前缀的前面放置单字母范围前缀标明了这种增长，但变量名的长度并没有增加很多。

变量范围前缀

范围 前缀 例子

全局 g gstrUserName

模块级 gm gmblnCProgress

本地到过程 无 dblVelocity

5 应用程序的界面设计

5.1 概述

5.1.1 目的

在本界面设计的规范中，目的是提高Windows应用程序之间及应用程序内部在视觉、功能上的一致性。这种一致性可以加快开发和学习的过程，提高生产率；减轻由于应用程序的界面不同而引起的混乱；给用户一种稳定感。

5.1.2 目标

在本规范中主要是为设计人员和开发人员提供尽可能的界面设计指南，不可能为所有的界面提供建议。设计人员和开发人员可以加以扩充，但是，应该尽量保持Windows程序的一致性。

第27页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

5.2 窗体/对话框设计

5.2.1 一般说明

在本规范中主要对应用程序的窗体/对话框界面进行说明。并且主要是说明在窗体中控件的排列规范

5.2.2 消息对话框

用来显示错误消息和其他重要信息的模式对话框叫消息对话框。在对话款中包含标题栏，用来表示消息的来源。在消息对话框中还包含一个只是正在被显示的消息种类的图形符号，消息的三种类型是：

(提示：信息框统一采用MessageBox)。

信息消息；

警告消息；

极重要消息。

图 4 信息消息框 图 5 警告消息框

图 6 极重要消息

第28页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

5.2.3 窗体

在窗体的设计中，本规范主要说明按钮在窗体中的放置位置。

窗体中的颜色设置为标准的Windows颜色，以银灰为主。窗体中文字颜色为黑色；

窗体中的字体为楷体，字号为1号；

窗体的大小应为60的倍数；

窗体中的标题栏中不能含有图标，文字对齐方式为左对齐，窗体中要包含关闭按钮。如果需要设置显示为（？）的帮助按钮；

窗体中主要控制要包含快捷键；

窗体的位置。窗体通常水平和垂直地置于应用程序窗口的中央。如果一个应用程序找到一个更适合对话框的位置，也可以放在别处。

如果按钮命令显示一个对话框，在标题中需要有如下的提示（…）。如(显示图例…)

按钮的大小。按钮的高为“27”，宽为“90”（在将按钮和对话框的网格对齐时，网格的间隔设为10-15）。当按钮的标题超过两个汉字时，可以适当增加按钮的宽。如果需要，可以增加按钮的高，当改变按钮的形状，风格时，应该经过项目组的统一；

推荐的按钮。每个对话框都至少包含一个关闭对话框的按钮。只要求用户确认（而不用选择）的消息对话框只包含一个标以“确认”的按钮。其他所有对话框都至少包含两个按钮：一个关闭对话框并启动一个动作；另一个关闭对话框但并不启动任何动作。启动动作的按钮通常标以“确认”。关闭对话框但不启动任何动作的按钮通常标以“取消”。某些对话框（称为多动作对话框）另外包括一些允许用户启动某些动作但不管比对话框的按钮。在这些对话款中，如果由这些附加按钮执行的动作无可挽回的修改用户的数据，则第一个动作已完成，“取消”按钮的标签就应该改为“关闭”。不管这个按钮标以“取消”还是“关闭”，用户都可以通过“ESC”键表示按下这个按钮。（确认和取消按钮没有助记符）如果标签是“关闭”，应该由一个字母“C”下画下划线作为助记符。

默认的按钮。对话框中的一个命令按钮可以指定为默认按钮，他在用户按ENTER键时按第29页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

下。默认按钮以一个粗边框却别其他按钮。

按钮的动态标签。个别的按钮的标签可以根据两种方式改变当前用户的可用性能：

如果按钮代表的动作当前不可用，其标签应当变暗；

如果按钮代表的动作的性质根据环境产生改变，其标签可以更改以反映这个改变；

按钮的排放。只要可能，按钮都以下述两种排放方式中的一种放置：

从右上角起沿窗体的右边界排放。（见图7）在这种方式下，按钮通常是等宽的。根据命令按钮是否启动一个动作将他们编组。如果存在一个确认按钮，按钮和取消按钮要编在一个组里，和其他动作按钮分开。

图 7 竖式按钮布局

沿窗体底部排成行。（见图9）根据命令按钮是否启动一个动作将他们编组。如果存在一个确认按钮，按钮和取消按钮要编在一个组里，和其他动作按钮分开。

第30页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

图9 横式按钮布局

按钮排放的另外规则：

最重要的按钮-典型的，是默认按钮-应该放在顶部（如果用排放方式A）或者在左边，后跟其他的可启动动作的按钮，在接HELP按钮。

Help按钮放在其他按钮之后，是它位于对话框的右下部附近。

如果单是一种方位没有足够的空间容纳下所有的按钮，可以用排放方式A排放最重要的命令按钮，而用排放方式B排放其他所有的命令按钮。

图中表示了按钮之间的间隔大小。图中的矩形代表窗体中的按钮。

宽度90

间距10

高度27

间距10或15

窗体中Text设置；

第31页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

Text框的高度=ComboBox的缺省高度一致

Text框之间的间隔=15

窗体中CheckBox设置；

CheckBox的高度= ComboBox的缺省高度一致

CheckBox之间的间隔=15

窗体中Option设置；

Option的高度= ComboBox的缺省高度一致

Option之间的间隔=15

窗体中Label设置；

Label的高度= ComboBox的缺省高度一致

Label之间的间隔=15

窗体中TabPage设置；

如果采用Ms的SSTab控件或者类似的Tab控件，则必须将该控件设置为属性页的显示方式。

窗体中的控制和窗体、控制和控制之间的位置关系

窗体中的控制（已经作了规定的除外）与窗体对齐边缘的距离为“15”。

第32页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

图 13 窗体中的控制

如果一个控制最为另一个控制的容器，着这个控制与另一个控制边缘对齐的距离为“15”。如下图

图 14 控制容器中的控制

6 防错误处理

在涉及一些系统性的操作时，必须使用防错误的语句。

这些操作包括：数据库连接和数据库访问、网络访问、文件存取、对象句柄的使用(如使用窗口对象的句柄等)、指针使用等。

防错误的语句包括以下几种情况：

一般合法性判断：使用assert；

异常处理：使用开发工具或语言提供的错误处理语句（如Delphi中try … except … end或try … finally … end语句块等）；

第33页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

7 框架和各个工具的接口

7.1 接口方式

软件产品采用Microsoft的COM技术作为系统的接口方式。

7.2 接口要求

7.2.1 概述

采用基于COM技术的接口方式可以采用ActiveX EXE, ActiveX DLL等的形式实现。在我们的系统中各个工具采用ActiveX DLL的形式提供工具的应用逻辑层，在ActiveX DLL中可以提供适当的Form来作为界面。

7.2.2 实现

各个工具提供的ActiveX DLL应该有以下的特点：

一个可以通过外部创建的对象。即在ActiveX DLL中的Class的属性应该为MutiUse或者GlobalMutiUse

在这个外部可以创建的对象中，提供和框架的接口。如：得到设计对象标识码的方法。

在这个外部可以创建的对象中，提供显示工具窗口的方法。如：显示可靠性预计的窗口的方法。

7.2.3 可预知的限制

在ActiveX DLL中提供一个MDI的子窗口可能会有问题。

第34页 共38页

数字音频信息管理系统(AudioMIS)——软件标准规范

8 版本号格式

软件产品中采用如下的版本号格式：X.X.X.X

例如：当一个可发布的程序完成后将版本号标为”1.0.0.0”

第一位：版本号。表示软件又重大的改进后形成的版本。

第二位：维护号。表示已有的版本的基础上修改了某些错误形成的版本。

第三位：补丁号。表示当程序修改了某些错误，但是还来不及形成新的维护号时，用补丁号。

第四位：当出现一个紧急的程序错误时，修改后的程序用它标识，但不作为发布程序的版本号

9 检查单

为便于本规范的执行，特制定本检查单，以便于软件项目开发人员的自查和互查。本检查单要求开发人员对软件项目的文件命名、文件存储目录、命名规则、界面形式等进行自查和互查，并由主管领导审核。

第35页 共38页