为了规范程序代码编写,提高代码可读性,降低后期维护成本,提高办公效率,建议以后编写的程序按以下几条规范进行: 一、 统一VBSCRIPT和ASP程序编写规范: (一)变量命名规则: 由于在ASP和VBSCRIPT中因为不需要声明变量,同时不能声明变量的类型,但为了提高代码的可读性,养成好的开发习惯,对于本系统开发的变量命名统一规则如下: 1. 使用Dim、Public、Private声明变量; 例如:Dim iStudentNum 2. 变量类型的体现: a、 整型变量:以小写字母i开头,后面跟变量标示符,英文单词的第一个字母大写。 例如:下面声明一个存储数据库记录多少的变量 Dim iResordsetNumber b、 单精度实体变量:以小写字母f开头,后面跟变量标示符,英文单词的第一个字母大写。 c、 双精度实体变量:以小写字母d开头,后面跟变量标示符,英文单词的第一个字母要大写。 d、 字符型变量:以小写字母s开头; e、 布尔型变量:以小写字母b开头; f、 数组变量:数组类型+“_”+“Array”+“_”+“变量标示符” 例如:定义一个存储学生成绩的数组(存储单精度实体类型变量) Dim f_Array_StudentMark 3. 变量标示符要符合标示符标准,同时容易理解,尽量使用英文单词来代替,尽量避免使用缩写或简写。 例如:存储校友通讯录的字符串变量定义为: Dim sSchoolfellowAddressList; 虽然这样定义在输入的时候比较麻烦,但是,它大大提高了程序的可读性,见其变量命名就知其意。在做变量查找的时候也比较方便。 速度和性能总是不能两全,为了方便后者我们也就只有牺牲速度。 4.在变量定义后面加变量功能定义的注释。 (二)常量命名规则: 类型体现和上面一样,不一样的地方是,所有后面的标示符全部大写,例如: 定义一个存储语言种类的的字符型常量: Const sLANGUAGE_TYPE=”Chinese” (三)功能函数、过程命名规则: 1. 使用Function声明函数,用Sub声明过程; 2. 函数名或过程名的第一个字母大写,且后面的每个单词第一个字母大写。 例如: Function CheckValidityOfInput(sStuentMark) '此处写代码 ………… End Function 3. 函数名或过程名要容易读,简单明了。 4. 在函数前面加注释,说明函数功能、参数说明、创建日期、修改日期、修改原因、创建人、修改人等相关信息。 |