ASP编程规范

大鸟，飞起来 · 发表于 2006-4-12 02:15:16

<

>程序代码编写统一规范方案 为了规范程序代码编写，提高代码可读性，降低后期维护成本，提高办公效率，建议以后编写的程序按以下几条规范进行： 一、统一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. 在函数前面加注释，说明函数功能、参数说明、创建日期、修改日期、修改原因、创建人、修改人等相关信息。 （四）代码缩进标准： 为了提高代码的美观型和易读性，在此提出代码编写的版面格式：区间与区间之间以一个<Tab>为间距。 例如： ‘*********************************************************** ‘功能：检测输入字符串中的单引号，如果有则把原来的一个单引号变成两 ‘ 个单引号，两个变成四个，依次类推，从而避免SQL语句执行错误。 ‘创建人：XXXX ‘创建时间：2002-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) <>"'" Then sApartString = sApartString & _ Mid(Trim(sInputString), iCirculationControl , 1) Else sApartString = sApartString & "''" End If Next CheckValidityOfInput = sApartString End Function 二、统一JavaScript程序编写规范： JavaScript的命名规则和上面大部分相同，唯一不同的地方是：变量使用Var来声明，在声明结束后以分号（；）结束。 函数的代码要求层次清楚，该写在下一行的地方尽量往下一行写，不要在一行中完成所有代码，这样看起来不容易，检查错误也特别费时。 在写函数的时候记着加注释内容，以便以后维护时快速了解程序功能。 下面是一个JavaScript程序： <Script Language=”JavaScript”> //*********************************************************************** //功能：对Form中的Text,Password,TextArea对象进行单引号处理，解决由于单引号 // 起的系统错误。 //创建人：XXXX //创建时间：2002-7-8 //修改时间： //修改原因： //修改人： //********************************************************************** function CheckElement() { var sNeedCheck=""; //检测属于INPUT标签的内容 var iControlInput=0; //控制循环 var iLocationInput=0; //控制位置 var iLengthInput=0; //存储字符串长度 var sCheckingInput=""; //正在检测的字符 var sReplaceInput=""; //替换字符 var sHaveCheckInput=""; //已经检测的字符 var objInput; //存储INPUT对象； var objTextArea; //存储TextArea对象 var iControlTextArea=0; var iLocationTextArea=0; var iLengthTextArea=0; var sCheckingTextArea=""; var sReplaceTextArea=""; var sHaveCheckTextArea=""; //检测页面中的Text和Password对象中的单引号 for (i = 0; i < document.all.tags('INPUT').length; i++){ objInput = document.all.tags('INPUT'); if(objInput.type=='text'|| objInput.type=='password'){ sNeedCheckInput=obj.value; iLengthInput=sNeedCheckInput.length; for(iControl=0;iControl<iLength;iControl++){ sCheckingInput=sNeedCheckInput.charAt(iControl); if(sCheckingInput==”’”) sReplaceInput=”’’”; else sReplaceInput=sCheckingInput; sHaveCheckInput=sHaveCheckInput+sReplaceInput; } } objInput.value=sHaveCheckInput; } //检测页面中的TextArea对象中的单引号 for (i = 0; i < document.all.tags('TEXTAREA').length; i++){ objTextArea = document.all.tags('TEXTAREA'); if(objTextArea.type=='text'|| objTextArea.type=='password'){ sNeedCheckTextArea=obj.value; iLengthTextArea=sNeedCheckTextArea.length; for(iControl=0;iControl<iLength;iControl++){ sCheckingTextArea=sNeedCheckTextArea.charAt(iControl); if(sCheckingTextArea==”’”) sReplaceTextArea=”’’”; else sReplaceTextArea=sCheckingTextArea; sHaveCheckTextArea=sHaveCheckTextArea+ sReplaceTextArea; } } objTextArea.value=sHaveCheckTextArea; } } </Script> 三、系统性能提高，代码规范： 1.在ASP页面内，凡是使用CreageObject()创建的对象(Com、Recordset等)，对于这些变量，应当在该页结束进行对象释放：即 Set 对象变量名=Nothing 2.数据库打开以后在不用的时候（通常是本页最后面），需要对连接进行关闭； 3.对于SQL语句，存储过程，尽量避免使用*来取所有字段,为了代码的易读性，SQL关键字要求全部大写，字段部分小写。 例如： SELECT name,age,birthday,telephone,address FROM SchoolFellow.Address WHERE name=’xxxx’ ORDER BY birthday DESC 4.在ASP页中所有属性值尽量使用双引号括起来，特别是有属性Value的值，不要因为省时间而把双引号去掉（有的地方虽然可以去掉，程序不会出现错误，但，在有的地方去掉双引号会引来更多的麻烦。） 例如： <INPUT type=”text” id=”ClassID” name=”ClassID” value=”<%=sClassID%>”> 在这个例子中，如果把Value属性值的单引号去掉，如果数据库中出来的值有空格，空格后面还有值，结果，显示的内容只有空格前面的内容，而后面的内容就会丢失。这只是其中一种情况，其他还有很多未知情况发生。 5. 配对标签问题：对于象<a></a>之类的标签，要注意检查配对的位值，有没有结束标志。 6. 对于需要输入字符串，且需要使用SQL语句的地方，需要进行单引号处理，调用/include/CheckQ.asp中的两个方法（一个是客户端处理，一个是服务器端处理，根据需要进行调用，安全性要求高的地方多数情况下采用服务器端处理。）之一。 7. 为了提高安全性，能使用ASP编写的代码，尽量采用ASP编写，在服务器端运行，不让用户看到代码。 8. 对于安全性要求特别高的地方，建议采用三层结构：使用VB或Delphi编写商业逻辑层代码(COM)，尽量把数据库的连接部分封装到组件中，提高安全性能，通过组件和数据库交流。 9. 对于网站的安全性，应该采用好的断口扫描软件，查看网站已经打开的断口，把不安全的断口给关闭。 四、养成写开发文档的习惯： 对于每一个页面设计（前接页，后接页），包括功能说明，页面设计，页面名称，存放位置等，应当有相应的文档记载。对于发生改动的地方，需要保留原来的部分（注释或备份），并说明备份文件存放的地方，改动时间，修改人。 对于程序部分，应该有相应的设计流程，改动的时候，也需要设计改动流程图，以便以后进行对比，和查找问题所在位置，以及问题的严重性分析。 

[此贴子已经被作者于2006-4-11 18:25:23编辑过]

大鸟，飞起来 · 发表于 2006-7-1 15:04:37

<

>第一章 ASP编码规范通述 　　　　ASP编码分为两大部分，一部分为静态文件编码，一部分为包含服务器端脚本的动态文件编码。 　　　　静态文件编码分script编码和HTML编码两部分。 　　　　服务器端编码则分为服务器脚本、客户端脚本、HTML脚本三部分。 　　　　编码规范采用如下约定： 　　　　所有客户端脚本一律使用javascript 　　　　所有服务器端脚本一律使用VBscript 　　　　静态页面输出一律使用HTML脚本 　　　　本规范不适用于由服务器端脚本所产生的客户端脚本代码。 　　第二章静态文件编码规范： 　　　　静态文件脚本部分采用javascript编写。输出部分采用HTML标记语言。 　　1. HTML标记语言编码规范 　　1.1 标记的换行规范： 　　* 一个标记必须占用一行。不得出现两个标记在同一行的情况(同一标记的关闭标记除外)，如：　 　<tr><td>text</td></tr> 　　而必须写成：
<

>　　<tr> 　　 <td>text</td> 　　　　 <tr>
<

>　　1.2 标记的关闭规范 　　* 静态文件内容必须包含在<body></body>标记中间 　　* <body>标记必须包含在<html></html>标记中间 　　* 对于需要关闭的标记，如：　　　　 <html><title><body><table><tr><td><textarea><select><option><div>
<

>　　　　必须同其关闭标记同时出现。如　　　　 <body>...................</body>
<

>　　* 不得出现交叉包含的语句，如：　　 .....
<

>　　1.3 标记的属性赋值规范 　　　　对于接受属性的标记，属性值必须使用双引号或者单引号包围。如:　　　　 <body bgcolor="red"> 　　　　
<

>　　1.4 标记的缩进规范 　　* 最高一级的父标记采用左对齐顶格方式书写。 　　* 下一级标记采用左对齐向右缩进一个Tab的方式书写 　　　　在下一级依此类推，分别左对齐相对于父标记向右缩进一个Tab的方式书写 　　* 同一级标记的首字符上下必须对齐。 　　2. 客户端javascript规范 　　2.1 变量命名规范 　　* 常量以及全局变量名必须全部使用大写字母 　　* 变量名首字母必须小写。 　　* 变量名必须使用其类型的所写字符串开始。各种类型的所写字符串如下： 　　* 整型变量：int 　　* 长整型变量：lng 　　* 浮点型变量：flt 　　* 双精度变量：dbl 　　* 对象引用变量：obj 　　* 字符串变量:str 　　* Date类型变量：dtm 　　* 变量名必须采用有意义的单词命名，如： 　　strUserName、lngArrayIndex 　　* 变量名除首字母小写外，其他单词首字符必须大写 　　* 如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词所写的变量名必须在定义时给出注释,如：　 　var strAdName //用于表示Administrator帐户的名称 　　var strAdminName //不用给出注释，Admin被广泛了解
<

>　　2.2 变量使用规范 　　* 变量使用前必须定义。没有定义的变量禁止使用 　　* 变量的使用尽量缩小到小的作用域。如循环使用 for(var I=0;I<12;I++){ } 　　而不是： 　　var I; 　　for(I=0;I<12,I++){ }
<

>　　2.3 对象命名规范 　　各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀： 　　* text输入框:txt 　　* button按钮：btn 　　* select下拉选择框：sel 　　* option项

pt 　　* form表单：frm 　　* frame框架：fra 　　* hidden表单项：hdn 　　* div标记：div 　　* span标记:span 　　* 对话框对象:dlg 　　* 窗口对象：win 　　2.4 函数以及子过程命名规范 　　* 函数命名必须使用动词＋名词对的方式，并且能够体现函数的功能 　　* 函数命名的动词前缀必须是同函数功能相关的完整动词 　　* 函数命名第一个单词的首字母小写，后面每一个单词的首字母大写 　　第三章动态文件编码规范 　　1. HTML书写规范 　　　　HTML书写规范必须符合静态文件HTML标记书写规范，参考（第二章第一节） 　　2. 客户端脚本规范 　　　　动态文件客户端脚本一律采用javascript书写，并必须符合静态文件编码规范中有关javascript编码规范的规定(参考第二章第二节) 　　3. 服务器端脚本书写规范 　　　　服务器端脚本书写采用VBscript书写 　　3.1 命名规范 　　3.1.1 VBscript脚本变量命名规范 　　* 常量以及全局变量必须全部使用大写字母 　　* 常量必须使用CONST_前缀 　　* 全局变量必须使用G_前缀 　　* 变量名首字母必须小写。 　　* 变量名必须使用其类型的所写字符串开始。各种类型的所写字符串如下： 　　* 整型变量：int 　　* 长整型变量：lng 　　* 浮点型变量：flt 　　* 双精度变量：dbl 　　* 对象引用变量：obj 　　* 字符串变量:str 　　* Date类型变量：dtm 　　* 变量名必须采用有意义的单词命名，如： 　　strUserName、lngArrayIndex 　　* 变量名除首字母小写外，其他单词首字符必须大写 　　* 如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词所写的变量名必须在定义时给出注释,如： 　　dim strAdName ‘用于表示Administrator帐户的名称 　　dim strAdminName ‘不用给出注释，Admin被广泛了解 　　　　 　　3.1.2 对象命名规范 　　各种对象如Connection、Recordset、Command在命名时必须使用以下对应前缀： 　　* Connection对象：conn 　　* Recordset对象：rs 　　* Command对象:cmd 　　* Parameter对象：param 　　* Field对象:fld 　　* Error对象：err 　　3.1.3 函数以及子过程命名规范 　　* 函数命名必须使用动词＋名词对的方式，并且能够体现函数的功能 　　* 函数命名的动词前缀必须是同函数功能相关的完整动词 　　* 函数命名第一个单词的首字母大写，后面每一个单词的首字母大写 　　3.1.4 常用变量命名规范： 　　　　说明：包含在[>中的部分为可省略部分 　　* Connection对象：conn[Name>。Name为所连接数据库的服务器名字 　　* Recordset变量命名规范：rs[Name>。Name为自定义的同rs存储内容有关的英文单词组合 　　* Command对象：cmd[Name>。Name为自定义的同command目的有关的英文单词组合 　　* SQL语句字符串变量：strSql[CommandName>。CommandName为自定义的同Sql语句功能相关的英文单词组合，如： 　　strSqlUpdateModify 　　strSqlInsertUser 　　3.2 代码书写规范 　　3.2.1 变量明确声明原则 　　* 所有ASP程序文件，必须在代码的第一行包含<%option explicit%>。转为变量明确声明模式 　　3.2.2 字符集设定原则 　　* 所有将对客户端产生中文输出的ASP程序文件，必须在输出前设定Charset为"GB2312".如：Response.Charset = "GB2312" 　　3.2.3 函数使用原则 　　* 尽量使用函数封装代码块 　　* 连续代码块尽量不要超过50行。最多不得超过70行 　　* 尽量使用局部变量。 　　* 如有涉及到全局的资源，如Connection，尽量作为函数的参数传入 　　* 所有在函数内部创建打开的资源，在退出函数前必须关闭释放。如：Recordset，Command 　　3.2.4 Request、Session、Application使用规范 　　* 所有需要放入Session、Application中的对象，必须采用有意义的英文名字。除了被广泛了解的单词缩写以外，不得采用单词缩写。如：　　 Session("cp") = strCurrentUserIP ‘不允许 　　Session("CurrentUserIP") = strCurrentUserIP 　　Session("

wd") = strPwd ‘允许，Pwd被广泛了解为密码
　　* 所有需要在代码内用到的Request、Session、Application中的元素，必须在代码头部赋值给代码内声明的变量。 　　* 如果获得Form中提交的内容，必须使用Request.Form("itemName"). 　　* 如果获得QueryString中提交的内容，必须使用Request.QueryString("itemName") 　　* 不得在代码中出现Request("")这样的引用方式 　　3.2.5 HTML同服务器端脚本混合使用原则 　　* 服务器端脚本标记"<%"必须同其上一行紧邻的标记左对齐，如：　　 <table> 　　<% 　　do while not rs.eof 　　%> 　　 <tr> 　　 <td>text</td> 　　 </tr> 　　<% 　　 rs.movenext 　　 loop 　　%> 　　</table>
　　* 服务器端脚本标记"<%"同其后的代码不得在同一行书写 　　* "%>"同其前面的代码不得在同一行书写 　　* 服务器端脚本标记"%>"同其最近的"<%"标记对齐 　　* 服务器端内部的HTML代码依据静态文件的HTML缩进规则编写，不遵循服务器端脚本缩进规则 　　* HTML标记内部的代码，依据服务器端脚本的缩进规则，不遵循HTML代码缩进规则第四章常见错误 　　1. ADO的事务处理 　　1.1 错误代码：80004005。 　　1.1.1 错误描述： 　　　　Microsoft OLE DB Provider for ODBC Drivers 错误 ''''''''80004005'''''''' 　　　　不能在 firehose 方式下启动事务 　　1.1.2 解决方法： 　　　　在开始ADO的事务的时候，必须首先关闭使用同一个连接对象打开的记录集，或者在打开那些游标集之前，设置游标集位置类型为adUseClient.（使用客户端游标集） 　　　　 　　第五章代码习惯书写示例 　　1. ADO对象的使用 　　1.1 ADODB.Connection对象 　　1.2 ADODB.Command对象 　　1.3 ADODB.Recordset对象 　　1.3.1 创建：　　　 　Set rs = Server.CreateObject("ADODB.Recordset") 　　　　rs.CursorLocation = adUseClient 　　　　rs.Open strSql,conn,1[,1> ‘必须指定游标类型

Demo · 发表于 2007-9-10 18:03:02

请教：怎么用ASP程序+GEO Media Web Map 结合开发包含电子地理信息地图的应用软件？

香耐儿 · 发表于 2009-4-10 09:17:09

偶路过,留个脚印先.....

古之立大事者，不惟有超世之才，亦必有坚忍不拔之志。---魔兽剑圣异界纵横
小游戏极品家丁龙蛇演义恶魔法则飞升之后异界枪神凡人修仙传魔兽领主超级农民成人小游戏极品公子

账号		自动登录	找回密码
密码			入学

ASP编程规范

偶路过,留个脚印先.....

浏览过的版块