一份代码编写标准

一、通用源代码方法准则 1.1 开拓东西

引荐运用microsoft  公司的visual interdev 来抄写asp 代码，运用macromedia ? 公司的dreamweaver 来抄写html代码，也不妨运用ultraedit、aspedit 2000等开拓东西。

1.2 缩进空格

缩进空格是指在每头等有两到四个空格。不要在源代码中保持tab字符，这是由于tab字符会跟着各别用户的各别树立和各别的资源处置东西（打字与印刷、文书档案、本子遏制等）而代办各别的宽窄。

1.3 数据正当性查看

一切表单提交页面中，表单上必需填写名目和填写名目中不法输出的确定都在页面顶用javascript在存户端确定，即使必需和效劳器端数据比拟本领确定输出名目能否精确不在此例。 一切提交的消息(get办法及post办法)都必需在效劳器端从新举行数据正当性校验，并过滤不法字符（& ; ` ' \ " | * ? ~ < > ^ ( ) [ ] { } $ \n \r），比方，将"'"替代成"''" (两个单引号)号（替代字符串的处事将一致运用大众的checkinputstring(str) 因变量）；而对于数字型变量，要查看输出的数据能否全为数字（javascript中运用isfinite或isnan, vbscript中运用isnumeric）。

1.4 参数传播

倡导运用post本领，而不引荐运用get本领； 严禁运用get本领、session或其它办法传播sql语句； 遏止运用get办法传播洪量的查问字符串，更加是一经源代码的中国字,http和议传递表单域比查问字符串功效要高，并且带有一个大的查问字符串的页面在某些欣赏器上会作废； 遏止运用session、cookie传播非对话功夫需要的参数。

1.5 url

包括头文献，页面包车型的士链接，提交的页面，用到的图片，即使援用的是如"include"、"image"等大众局部，必需运用一致路途，即以虚根目次"/"发端的路途，以普及运转功效。比方：

6.4 运用最大略的游标典型和记载锁定办法

在 ado 中设置了四种各别的游标典型： l动静游标(adopenforwardonly) - 用来察看其余用户所作的增添、变动和简略，并用来不依附书签的 recordset 中百般典型的挪动。即使供给者扶助，可运用书签。 l键集游标(adopenkeyset) - 其动作一致动静游标，各别的不过遏止察看其余用户增添的记载，并遏止考察其余用户简略的记载，其余用户所作的数据变动将仍旧看来。它一直扶助书签，所以承诺 recordset 中百般典型的挪动。 l静态游标(adopendynamic) - 供给记载汇合的静态复本以搜索数据或天生汇报。它一直扶助书签，所以承诺 recordset 中百般典型的挪动。其余用户所作的增添、变动或简略将不看来。这是翻开存户端 (ador) recordset 东西时独一承诺运用的游标典型。 l仅向前游标(adopenstatic) - 除仅承诺在记载中向前震动除外，其动作一致动静游标。如许，当须要在 recordset 中来回挪动时就可普及本能。

在翻开 recordset 之前树立 cursortype 属性来采用游标典型，或运用 open 本领传播 cursortype 参数。局部供给者不扶助一切游标典型。请查看供给者的文书档案。即使没有指定游标典型，ado 将默许翻开仅向前游标。

在 ado 中设置了四种各别的游标典型： ladlockreadonly - 默许值，只读。没辙变动数据。 ladlockpessimistic - 顽固式记载锁定（逐条）。供给者实行需要的操纵保证胜利编纂记载，常常沿用编纂时登时锁定命据源的记载的办法。 ladlockoptimistic - 盛开式记载锁定（逐条）。供给者运用盛开式锁定，只在挪用 update 本领时锁定记载。 ladlockbatchoptimistic - 盛开式批革新。用来与登时革新形式差异的批革新形式。

翻开 recordset 前树立 locktype 属性可指定翻开时供给者该当运用的锁定典型。读取该属性可归来在翻开的 recordset 东西上正在运用的锁定典型。recordset 封闭时 locktype 属性为读/写，翻开时该属性为只读。

在本质运用进程中该当运用符合于处置工作的最大略的游标典型和记载锁定办法。比方：

仅翻开一个静态的记载集并输入： rs.open sql,conn,0,1 ' adopenforwardonly, adlockreadonly 翻开的记载会合有text典型的字段： rs.open sql,conn,1,1 'adopenkeyset, adlockreadonly

6.4 sql字符串过滤

一切的字符串输出框在向数据库提交查问、插入、简略或窜改一条记载时必需用字符串过滤因变量查看，即： 字符型：复写提交实质中的"'"、"''"等（运用大众因变量的checkinputstring()。)，并查看字符串的长度能否超长。 数值型：运用isnumeric()确定输出能否为数字。 整 型：运用int(), fix(),round() 截取其平头值。 日子型：运用isdate()因变量确定能否为精确的日子输出。

6.5 sql工作实行

对数据库操纵的工作普遍该当运用sql的保存进程实行。对于须要在asp页面中实行的数据库操纵，一切插入、简略、窜改数据库不得运用recordset东西，必需运用connect东西用sql语句实行，recordset只在实行查问时运用。一切检索数据库的操纵遏止运用"select * from …"，而要运用"select 字段一, 字段二, 字段三, … from…"。

6.6 ado东西的封闭

一切贯穿数据库页面中，connect和recordset等ado东西必需在用完后登时封闭(close)，而后将其东西开释（set ***=nothing）。

[page_break]七、cookies 7.1 cookies的效率域

cookies的path属性规则了cookies归来效劳器的简直路途。为了使cookies不妨在所有网站的各个目次都不妨起效率，应将domain域属性设为："/"， cookies的domain域属性控制了cookies可由欣赏器投递之处。为了使cookies不妨在所有网站的各子站点都不妨起效率，应将domain域属性设为：".yourdomain.com"。该值将动作恒量cookie_domain放入站点的大众文献中。即：

response.cookies("username").path="/" response.cookies("username").domain= cookie_domain

7.2 cookies的灵验期

cookies的expires属性规则了cookies的中断效率功夫。即使要创造一个对话功夫的cookies，即要在存户中断欣赏后作废，则确定不许树立该属性。

7.3 cookies的安定

cookies里面的敏锐消息必需加密，该加密办法在大众密钥因变量库中设置。

1.5 url 包括头文献，页面包车型的士链接，提交的页面，用到的图片，即使援用的是如“include”、“image”等大众局部，必需运用一致路途，即以虚根目次“/”发端的路途，以普及运转功效。比方： <a href="/index.asp"> <img src="http://edu.chinaz.com/http://edu.chinaz.com/get/website/website_other/images/logo.gif”>

在一个对立独力的模块里面，不妨运用对立路途，以普及可移植性。然而，遏止运用“..”归来上头等目次，即遏止运用一致“..http://edu.chinaz.com/http://edu.chinaz.com/get/website/website_other/images/logo.gif”的url。对立路途如次抄写： <a href="index.asp"> <img src="http://edu.chinaz.com/get/website/website_other/images/logo.gif”>

保证在指向目次的 url 中运用后斜杠 (/)。即使您简略了后斜杠，欣赏器就会向效劳器发出乞求，不过为了报告效劳器，它在乞求目次。欣赏器就会发出第二个乞求，将斜杠附加到 url 反面，惟有尔后，效劳器本领以该目次的默许文书档案或目次列表（即使没有默许文书档案且起用了目次欣赏的话）相应。附加斜杠可省去第一个、无效的住返。为便于用户观赏，不妨简略表露称呼中的后斜杠。 比方，写： <a href=http://msdn.microsoft.com/workshop/” title=”msdn webworkshop”>http://msdn.microsoft.com/workshop </a> 这也实用于指向 web 站点上网页的 url：运用底下的：<a href=http://msdn.microsoft.com/”>，而不运用 <a href=http://msdn.microsoft.com”/>。

1.6 日子

在运用、确定和表露日子时，确定要决定年为4位。一致设置为 长日子方法为: xxxx年xx月xx日 短日子方法为：xxxx-xx-xx 在asp输入时必需运用formatdatetime()因变量举行方法化，前者输时髦一致运用xxxx-xx-xx方法，并在后端运用isdate()举行检查。二、html 2.1 标志

html 对巨细写不敏锐，但为革新可读性，规则小写一切标记、属性，小写属性值，属性值外必需加引号，如：<table border=”0” cellspacing=”0” cellpadding=”0” align=”left”>

2.2 meta 标志

一切华文页面，必需在“<head> … </head>”头中介入如次meta标志： <meta http-equiv="content-type" content="text/html; charset=gb2312"> 该meta标志刻画本页运用的谈话。欣赏器按照此项，就不妨采用精确的谈话源代码，而不须要读者群本人在欣赏器里采用。gb2312是指简体华文，iso-8859-1是指英文，而台湾big5内码的网页则是用big5。

在首页和各频段首页应介入如次meta标志： <meta name="keywords" content="yourkeyword"> 　　<meta name="description" content="your homepage's description"> 　　该meta标志证明本页的要害字和刻画。在页面里加上那些设置后，少许探求引擎就不妨让读者群按照那些要害字搜索到你的网页，领会你的网页实质。

在历次都须要从新天生的，不须要用户缓存的页面，应介入如次meta标志： <meta http-equiv="pragma" content="no-cache"> 该meta标志强迫性挪用网上的最新本子。欣赏器为了俭朴功夫，在当地硬盘上生存一个网上文献的偶尔本子。在你要从新挪用时，径直表露硬盘上的文献，而不是网上的。即使你想让用户历次都看到最新的本子，就加上这句话。

2.3 一致款式表援用

为了使所有网站的作风款式一致，必需一致运用大众的层叠款式列表，即在每个html文献的“<head> … </head>”头中介入： <link rel="stylesheet" type="text/css" href="/style/default.css">

即使名目对立比拟独力，该当运用本人的css设置，减少可移植性。

2.4 title设定

一切华文页面title树立需按照如次规范： yourdomain.com+空格+本页实质刻画

一切英文页面title树立需按照如次规范： yourdomain.com+空格+ －+空格+本页实质刻画

2.5 表单

2.5.1 文本框：文本框（<input type=”text” name=”” …>）的宽窄（size属性）以数据库中对立应的字段长度为参考，并参照临近文本框的宽窄，以场面为规则决定；文本框的最大实质长度（maxlength属性）以数据库中对立应的字段长度为规范决定。

2.5.2 表单提交：必需运用post本领，而不承诺运用get本领。

2.6 表格

2.6.1 莫大和宽窄的设置：应径直在单位格属性内用音素数设置，尽管不要用百分比设置，也不要用空缺图去撑这个单位格。如特出情景诉求，只宜用百分比对单位格指定宽窄，由于netscape不扶助百分比设置的莫大。

2.6.2 空单位格：一切须要指定背底色或边框色的空单位格请确定要在该单位格内插入 ，即使该单位格的莫大<9或宽窄<5时，请用img目次下的none.gif。无背底色和边框色的空单位格，只是是用来定位时，请如许写：<td height="??" width="???"></td>

2.7 图片

<img>标签必需运用width和height属性来设置图片的尺寸，以加速欣赏器表露页面包车型的士速率。对于普遍的非占位用的图片，必需运用alt属性来设置其文本表露。

2.8 解释

运用解释证明每一子块区的发端和中断，解释语句运用英文。如： <!— user login in zone --> … …

[page_break]三、javascript 3.1 标志 javascript是一种对巨细写敏锐的谈话，谈话的要害字依照javascript的诉求抄写，要害字小写，因变量、东西运用恒定的巨细写。

3.2 因变量/进程

用户自设置的因变量应放在文献的<head></head>局部，以保证用户在与页面其余局部举行交互之前，一切因变量都已承载，且筹备停当。页面加载时的举措也应写成因变量/进程，在body的onload事变中触发。

3.3 字符串串联

制止在轮回语句中运用字符串串联。 倡导运用+＝演算符，即，运用s += ”某字符串”，而不要运用s = s + ”某字符串”。

3.4 事变处置器

事变处置器嵌在html标志之中，应证明剧本典型，如：onmouseover=”java script:window.status=’大师好’;return true”>

3.5 解释

运用“//”来解释反面一条龙内的语句，运用“/* …… */”来解释成块的语句。其余，剧本要运用html的解释标志“ </script>

四、vbscript 4.1 恒量/变量、因变量/进程的定名

恒量和变量定名应以代办其含意、功效的单词构成，每个单词的发端假名小写，其他假名小写，轮回变量i，j，k不妨不同。对于一再运用的或长的项，引荐运用规范缩略语以使称呼的长度合生化。 对于变量来说，即使该变量是一个进程级（进程，子进程或因变量进程中的）的变量，应在其前方运用“m_”的前缀来表白它是一个限制变量。比方: m_blncalcinprogress。限制变量应独立在因变量或进程中设置。 该当给变量加前缀来指明它们的数据典型。依照处置变量的办法（而不是本来际数据典型）在 asp 代码中证明变量。比方： 前缀 运用的变量 变量示例 bln boolean blnsuccess cur currency curamount dbl double dblquantity dat date and time datdate flt float fltratio lng long lngmilliseconds int integer intcounter str string strname arr array arrusers() obj com object objpipeline

因变量及进程的定名应按照之上基础准则，并以一个动词发端

4.2 语句

小写或首假名小写if, then, else和end if等vbscript语句。

4.3 字符串贯穿

为维持普遍性并到达更有自述性的剧本目的，运用字符串贯穿符(&）包办减号（+）。

4.4 解释

运用证明证明难以领会的或搀杂的代码。行内解释该当在相映代码反面表露两个空格。在新的一条龙上发端的解释该当与前一条龙对齐。倡导运用单引号 (')包办 rem 要害字，在没有代码的行上加解释不妨运用rem 要害字。解释语句尽管运用英文。

六、数据库&ado操纵 6.1 unicode数据典型 数据库中有大概运用中国字的场合要运用unicode的数据典型，即运用nchar、nvarchar、ntext典型。

6.2 数据库贯穿

一切贯穿数据库的页面必需囊括贯穿数据的头文献connaaaaa.asp(即使须要各别的贯穿文献，aaaaa代办各别的模块)。在该文献中设置运用 oledb 供给者贯穿数据库的贯穿串（不承诺运用数据库处置员sa）。该文献将不安置在站点目次之下，运用“include file”的办法考察。 经过 oledb 运用 sql server ，运用底下的语法：

provider=sqloledb.1;password=mypassword;persist security info=true;user id=myuid;initial catalog=mydbname;data source=myserver;connect timeout=15

即使要运用数据构形，oledb的贯穿运用底下的语法：

provider=msdatashape; date provider=sqloledb.1;password=mypassword;persist security info=true;user id=myuid;initial catalog=mydbname;data source=myserver;connect timeout=15

6.3 ado 属性恒量的援用

即使须要运用ado恒量，应将底下的代码介入该文献中，即可径直考察一切的 ado 恒量：

6.4 运用最大略的游标典型和记载锁定办法

在 ado 中设置了四种各别的游标典型： l动静游标(adopenforwardonly) — 用来察看其余用户所作的增添、变动和简略，并用来不依附书签的 recordset 中百般典型的挪动。即使供给者扶助，可运用书签。 l键集游标(adopenkeyset) — 其动作一致动静游标，各别的不过遏止察看其余用户增添的记载，并遏止考察其余用户简略的记载，其余用户所作的数据变动将仍旧看来。它一直扶助书签，所以承诺 recordset 中百般典型的挪动。 l静态游标(adopendynamic) — 供给记载汇合的静态复本以搜索数据或天生汇报。它一直扶助书签，所以承诺 recordset 中百般典型的挪动。其余用户所作的增添、变动或简略将不看来。这是翻开存户端 (ador) recordset 东西时独一承诺运用的游标典型。 l仅向前游标(adopenstatic) — 除仅承诺在记载中向前震动除外，其动作一致动静游标。如许，当须要在 recordset 中来回挪动时就可普及本能。

在翻开 recordset 之前树立 cursortype 属性来采用游标典型，或运用 open 本领传播 cursortype 参数。局部供给者不扶助一切游标典型。请查看供给者的文书档案。即使没有指定游标典型，ado 将默许翻开仅向前游标。

在 ado 中设置了四种各别的游标典型： ladlockreadonly — 默许值，只读。没辙变动数据。 ladlockpessimistic — 顽固式记载锁定（逐条）。供给者实行需要的操纵保证胜利编纂记载，常常沿用编纂时登时锁定命据源的记载的办法。 ladlockoptimistic — 盛开式记载锁定（逐条）。供给者运用盛开式锁定，只在挪用 update 本领时锁定记载。 ladlockbatchoptimistic — 盛开式批革新。用来与登时革新形式差异的批革新形式。

翻开 recordset 前树立 locktype 属性可指定翻开时供给者该当运用的锁定典型。读取该属性可归来在翻开的 recordset 东西上正在运用的锁定典型。recordset 封闭时 locktype 属性为读/写，翻开时该属性为只读。

在本质运用进程中该当运用符合于处置工作的最大略的游标典型和记载锁定办法。比方：

仅翻开一个静态的记载集并输入： rs.open sql,conn,0,1 ‘ adopenforwardonly, adlockreadonly 翻开的记载会合有text典型的字段： rs.open sql,conn,1,1 ‘adopenkeyset, adlockreadonly

6.4 sql字符串过滤

一切的字符串输出框在向数据库提交查问、插入、简略或窜改一条记载时必需用字符串过滤因变量查看，即： 字符型：复写提交实质中的“’”、“’’”等（运用大众因变量的checkinputstring()。)，并查看字符串的长度能否超长。 数值型：运用isnumeric()确定输出能否为数字。 整 型：运用int(), fix(),round() 截取其平头值。 日子型：运用isdate()因变量确定能否为精确的日子输出。

6.5 sql工作实行

对数据库操纵的工作普遍该当运用sql的保存进程实行。对于须要在asp页面中实行的数据库操纵，一切插入、简略、窜改数据库不得运用recordset东西，必需运用connect东西用sql语句实行，recordset只在实行查问时运用。一切检索数据库的操纵遏止运用“select * from …”，而要运用“select 字段一, 字段二, 字段三, … from…”。

6.6 ado东西的封闭

一切贯穿数据库页面中，connect和recordset等ado东西必需在用完后登时封闭(close)，而后将其东西开释（set ***=nothing）。

五、asp步调 5.1 变量证明 在一切用到变量的asp页面中必需在步调证明的下一条龙写上<% option explicit %>。由于没声明的限制变量和全部变量一律慢（比设置过的限制变量要慢一倍）。被包括的大众文献不同。

5.2 步调证明

每一个步调文献的发端必需证明文献的效率或功效、步调的进口参数、参数证明、作家、编写日子(囊括天生日子、结果窜改日子)。方法如次：

<% '** ‘comment: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ‘input: (must) logon_id－user name; logon_pd－user password ‘ (plus) ‘editor: xxxxx 2000-11 ‘modify: xxxxx 2000-12 ‘** %>

5.3 最小化左右文切换

出于效劳器处置剧本本能的商量，倡导应尽管使html和剧本的左右文切换最小化。在大概的情景下，应在一页内运用少量大块剧本包办多个分别的片断。比方： <% if a > 1 then %> <a href=”1.htm”> 第一 </a> <% else %> <a href=”2.htm”> 第二 </a> <% end if %> 最佳写成如次方法： <% if a > 1 then response.write “<a href=””1.htm””> 第一 </a>” else response.write “<a href=””2.htm””> 第二 </a>” end if %>

5.4 分割剧本行以减少可读性

剧本行该当被一对定界符(“<%”、“%>”)分隔为代码块，而不是在每一条龙上抄写定界符。底下代码： <% stremail = session("email") %> <% strfirstname=request ("firstname") %> <% strlastname=request("lastname") %> 应写成如次方法： <% stremail = session("email") strfirstname=request ("firstname") strlastname=request("lastname") %> 对于独立的剧本行，在相同业上动作剧本维持定界符。比方： <% stremail=session("email") %> 即使剧本行由一个等号和一个变量构成，应将等号动作定界符的一局部。比方： <% = strsubscrlname %>

5.5 遏止运用session

因为session 对负载平衡有感化，所以session 将不复运用，而一致运用cookie来保护用户状况。

5.6 对于运转功夫长的页面，运用response.flush本领

每个写操纵城市爆发很大的体例开支（在 iis 中以及在经过搜集发送的数据量上面），所以写操纵越少越好。因为其启用慢且运用 nagling 算法（用来减少搜集塞车情景），tcp/ip 在发送少许大的数据块时比必需发送很多小的数据块时的功效高得多。 对于运转功夫长的页面，必需运用 response.flush 本领。这种本领将 asp 变换的一切 html 送给欣赏器。比方，在变换 1,000 行的表的前 100 行之后，asp 不妨挪用 response.flush，强迫将变换的截止送给欣赏器，如许可运用户在其他的行筹备好之前看到头 100 行。这种本领不妨将相应缓冲与欣赏器渐渐表露数据完备地贯串在一道。并且，还能处置当爆发特殊大的页面时，将占用很多效劳器外存的题目。 体味表白，不要历次反复实行精细轮回时都挪用它，如表露表的很多行时 - 每隔二十或五十行挪用一次大概比拟符合。

5.7 最佳迟一点赢得资源，早一点开释资源

用来 com 东西以及文献句柄和其它资源。在东西运用结束，应准时将 vbscript 变量树立为 nothing（在将记载集或贯穿树立为 = nothing 之前，不要忘怀挪用 close()）。

5.8 尽大概运用 server.transfer 包办 response.redirect

response.redirect 让欣赏器乞求另一个页面。此因变量常用来将用户重定向到一个登录或缺点页面。由于重定向强迫乞求新页面，截止是欣赏器必需到 web 效劳器往复两次，且 web 效劳器必需多处置一个乞求。iis 5.0 引入了一个新的本领 server.transfer，它将实行变化到同一台效劳器上的另一个 asp 页，而且将原页面包车型的士request集等十足变化到新页面。如许就制止过剩的欣赏器-web-效劳器的往复，进而革新了总体制统本能以及减少了用户的相应功夫。 查看“重定向”中的“新的目标”，即使不过想援用一个外部的文献动作进程，而后将遏制权再转回本页面，则不妨运用server.execute。

5.9 包括文献遏止运用 .inc 为扩充名

为了提防安置在包括文献中的敏锐消息被不料载入，遏止运用 .inc 为包括文献的扩充名，而运用 .asp 为扩充名，而且安置在专用的目次下。