《ASP开发规范要求_.docx》由会员分享，可在线阅读，更多相关《ASP开发规范要求_.docx（7页珍藏版）》请在三一文库上搜索。
1、ASP开发规范要求_ 为了规范程序代码编写，提高代码可读性，降低后期维护成本，提高办公效率，建议以后编写的程序按以下几条规范进行： 一、 统一VBSCRIPT和ASP程序编写规范： (一)变量命名规章： 由于在ASP和VBSCRIPT中由于不需要声明变量，同时不能声明变量的类型，但为了提高代码的可读性，养成好的开发习惯，对于本系统开发的变量命名统一规章如下： 1. 用法Dim、Public、Private声明变量; 例如：Dim iStudentNum 2. 变量类型的体现： a、 整型变量：以小写字母i开头，后面跟变量标示符，英文单词的第一个字母大写。 例如：下面声明一个存储数据库记录多少的
2、变量 Dim iResordsetNumber b、 单精度实体变量：以小写字母f开头，后面跟变量标示符，英文单词的第一个字母大写。 c、 双精度实体变量：以小写字母d开头，后面跟变量标示符，英文单词的第一个字母要大写。 d、 字符型变量：以小写字母s开头; e、 布尔型变量：以小写字母b开头; f、 数组变量：数组类型+“_”+“Array”+“_”+“变量标示符” 例如：定义一个存储同学成绩的数组(存储单精度实体类型变量) Dim f_Array_StudentMark 3. 变量标示符要符合标示符标准，同时简单理解，尽量用法英文单词来代替，尽量避开用法缩写或简写。 例如：存储校友通讯录的
3、字符串变量定义为： Dim sSchoolfellowAddressList; 虽然这样定义在输入的时候比较麻烦，但是，它大大提高了程序的可读性，见其变量命名就知其意。在做变量查找的时候也比较便利。 速度和性能总是不能两全，为了便利后者我们也就只有牺牲速度。 4.在变量定义后面加变量功能定义的说明。 (二)常量命名规章： 类型体现和上面一样，不一样的地方是，全部后面的标示符全部大写，例如： 定义一个存储语言种类的的字符型常量： Const sLANGUAGE_TYPE=”Chinese” (三)功能函数、过程命名规章： 1. 用法Function声明函数，用Sub声明过程; 2. 函数名或过程
4、名的第一个字母大写，且后面的每个单词第一个字母大写。 例如： Function CheckValidityOfInput(sStuentMark) 此处写代码 End Function 3. 函数名或过程名要简单读，简洁明白。 4. 在函数前面加说明，说明函数功能、参数说明、创建日期、修改日期、修改缘由、创建人、修改人等相关信息。 (四)代码缩进标准： 为了提高代码的美观型和易读性，在此提出代码编写的版面格式：区间与区间之间以一个为间距。 例如： * 功能：检测输入字符串中的单引号，假如有则把原来的一个单引号变成两 个单引号，两个变成四个，依次类推，从而避开SQL语句执行错误。 创建人：XXX
5、X 创建时间：2021-7-6 修改时间： 修改缘由： 修改人： 输入参数说明：sInputString：需要进行单引号检测的字符串 * Function CheckValidityOfInput(sInputString) Dim iCirculationControl 掌握循环 Dim sApartString 分别字符检测 Dim iLenOfInput 输入字符长度 iLen= Len(Trim(sInputString) For iCirculationControl = 1 To iLen If Mid(sInputString, iCirculationControl, 1) T
6、hen sApartString = sApartString _ Mid(Trim(sInputString), iCirculationControl , 1) Else sApartString = sApartString End If Next CheckValidityOfInput = sApartString End Function 二、 统一JavaScript程序编写规范： JavaScript的命名规章和上面大部分相同，唯一不同的地方是：变量用法Var来声明，在声明结束后以分号(;)结束。 函数的代码要求层次清晰，该写在下一行的地方尽量往下一行写，不要在一行中完成全部代
7、码，这样看起来不简单，检查错误也格外费时。 在写函数的时候记着加说明内容，以便以后维护时快速了解程序功能。 下面是一个JavaScript程序： 三、 系统性能提高，代码规范： 1.在ASP页面内，凡是用法CreageObject()创建的对象(Com、Recordset等)，对于这些变量，应当在该页结束进行对象释放：即 Set 对象变量名=Nothing 2.数据库打开以后在不用的时候(通常是本页最终面)，需要对连接进行关闭; 3.对于SQL语句，存储过程，尽量避开用法*来取全部字段,为了代码的易读性，SQL关键字要求全部大写，字段部分小写。 例如： SELECT name,age,birt
8、hday,telephone,address FROM SchoolFellow.Address WHERE name=xxxx ORDER BY birthday DESC 4.在ASP页中全部属性值尽量用法双引号括起来，格外是有属性Value的值，不要由于省时间而把双引号去掉(有的地方虽然可以去掉，程序不会消失错误，但，在有的地方去掉双引号会引来更多的麻烦。) 例如： ” 在这个例子中，假如把Value属性值的单引号去掉，假如数据库中出来的值有空格，空格后面还有值，结果，显示的内容只有空格前面的内容，而后面的内容就会丢失。这只是其中一种状况，其他还有许多未知状况发生。 5. 配对标签问题：
9、对于象之类的标签，要留意检查配对的位值，有没有结束标记。 6. 对于需要输入字符串，且需要用法SQL语句的地方，需要进行单引号处理，调用/include/CheckQ.asp中的两个方法(一个是客户端处理，一个是服务器端处理，依据需要进行调用，平安性要求高的地方多数状况下采纳服务器端处理。)之一。 7. 为了提高平安性，能用法ASP编写的代码，尽量采纳ASP编写，在服务器端运行，不让用户看到代码。 8. 对于平安性要求格外高的地方，建议采纳三层结构：用法VB或Delphi编写商业规律层代码(COM)，尽量把数据库的连接部分封装到组件中，提高平安性能，通过组件和数据库沟通。 9. 对于网站的平安性，应当采纳好的断口扫描软件，查看网站已经打开的断口，把担心全的断口给关闭。 四、 养成写开发文档的习惯： 对于每一个页面设计(前接页，后接页)，包括功能说明，页面设计，页面名称，存放位置等，应当有相应的文档记载。对于发生改动的地方，需要保留原来的部分(说明或备份)，并说明备份文件存放的地方，改动时间，修改人。 对于程序部分，应当有相应的设计流程，改动的时候，也需要设计改动流程图，以便以后进行对比，和查找问题所在位置，以及问题的严峻性分析。 更多信息请查看IT技术专栏 .