日期:2009-05-06  浏览次数:20389 次

程 序 设 计 规 范

1. 文件夹与文件的命名规则

1.1 文件夹命名


①     根据系统设计所规定的结构,建立相应的文件夹,根据需要建立子文件夹

②     文件夹的名称应尽量能够表达其意义,尽量使用英文命名,绝对不能汉字
③     文件夹名称的必须全部使用小写字母 (如 “ /example ” )

1.2 文件命名


①     文件的名称应尽量能够表达其意义,尽量使用英文命名,绝对不能汉字
②     文件名称全部使用小写字母(确保平台兼容)
③     文件名称一般采用”xxx_yyy.ext”格式,xxx(3-4个字母)表示分类,yyy(字母数自定)表示操作 (如 “ /example/exp_edit.htm ”)

2. 程序书写规则

2.1 变量命名


所有变量必须能够反映变量的作用,采用如下命名规则:
常数命名约定
用 Const 语句创建真正的常数。这个约定使用大小写混合的格式,并以“con”作为常数名的前缀。例如:
conYourOwnConstant

变量命名约定
出于易读和一致性的目的,请在 VBScript 代码中使用以下变量命名约定:

类型

前缀

示例

Boolean

Bln

blnFound

Byte

byt

bytRasterData

Date (Time)

dtm

dtmStart

Double

dbl

dblTolerance

Error

err

errOrderNum

Integer

int

intQuantity

Long

lng

lngDistance

Object

obj

objCurrent

Single

sng

SngAverage

String

str

strFirstName


变量作用域前缀
随着 Script 代码长度的增加,有必要快速区分变量的作用域。在类型前缀前面添加一个单字符前缀可以实现这一点,而不致使变量名过长。

作用域

前缀

示例

过程级


dblVelocity

Script级

s

sblnCalcInProgress

全程级

g

gblnCalcInProgress


⑷ 描述性变量名和过程名
变量名或过程名的主体应使用大小写混合格式,并且尽量完整地描述其目的。另外,过程名应以动词开始,例如 InitNameArray 或 CloseDialog。对于经常使用的或较长的名称,推荐使用标准缩写以使名称保持在适当的长度内。通常多于 32 个字符的变量名会变得难以阅读。使用缩写时,应确保在整个 Script 中保持一致。

对象命名约定,下表列出了 VBScript 中可能用到的对象命名约定(推荐):

对象类型

前缀

示例

文本框

txt

txtLastName

列表框

lin

linVertical

复选框

chk

chkReadOnly

组合框、
下拉列表框

cbo

cboEnglish

标签

lbl

lblHelpMessage

命令按钮

cmd

cmdExit

框架

fra

fraLanguage

图像

img

imgIcon

直线

lst

lstPolicyCodes