俺在工作实践中的定制的ASP编码规范,请大家指正、参考、多提意见
乱码 2001-07-20 02:58:21 网站编码规则和原则
一、 文件和文件夹的命名标准
a) 必须用小写英文字母命名;
b) 文件名要使用有意义的常见的英文单词。若文件名由多个单词组成,除第一个单词的首字母小写外,其余单词的首字母都必须用大写英文字母,例如:aboutUs.asp, newHorizon.gif;
c) 不许用空格键;不允许是用中文。
d) 所有的包含文件都用asp作为扩展名;
e) 不允许用汉语和汉语拼音命名。
f) 使用虚拟绝对路径。举例:<img src=”/news/images/logo.gif”>。
二、 图片文件命名规则:
a) 每一个栏目里必须建立一个images文件夹来存放图片,例如:一个主菜单里分五个栏目:aboutUs; products; community; forum; joinUs,则需要在每一个栏目下建立一个images文件夹来存放相关栏目所需的图片;
b) 在所有图片中,若是相片,则存成jpg格式, 若是按钮或其它不太复杂的图片,则存成gif格式;
c) 若是按钮图片,则命名为:btn+数字+状态(over/out).gif,若是标志图片,则命名为logo+有意义的名称.gif,其它图片则命名为:有意义的名称.gif/jpg;
三、 HTML编码及命名规则:
a) 必须为title赋值;
b) HTML文件加图片,即一个网页总长度限制在50k;
c) 必须定义每页的background color,即使background color为白色,也必须把它定义在<body>标签里;
d) 用级联格式页(即CSS)定义显示方面的内容,例如:字体、边框等等;
e) 用Dreamweaver4.0作为作为HTML的开发工具;
f) 设计以800*600作为显示器的标准;
g) 用IE4.0和Netscape4.0作为标准测试浏览器];
h) 图片的尺寸不能超过250*250,图片的大小不能超过30K;
i) 尽量不用Frame;
j) 尽量避免使用动态HTML,例如:层… …
k) 使用封闭式标签(balanced tags)
l) 类似于<html></html>,<head></head>以及<body></body>这类标签,一页中只能用一次,以避免在Netscape浏览器里出现刷新问题,在被包含文件中,不允许用以上标签;
m) 源代码要格式良好(这一点尤其重要),要像其他程序源码一样有缩进;
n) 不允许使用中文全角空格,必须使用“ ”。
o) Table的嵌套不要超过五层;
p) 所有内容都放至在表格中控制位置,避免用层来控制位置;
q) <form></form>标签必须在<table></table>标签外;
r) 不允许用保留字作为form的名字;
s) 必须规定form里的text field的最大尺寸不能超过数据库里的相应字段的最大尺寸;
t) 在一页中尽量不要用太多的form;
u) 在<table>标签中添加一个id属性,在相应的</table>标签后添加一个注释“<!— end table of id -->”。例如:
<table id=”header”>
……
</table><!— end table of header -->
v) 在空的<td></td>标签中插入空白图以避免Netscape中出现问题;
w) 图片一定要指定尺寸大小;
x) 图片和链接都不允许用本地路径,使用虚拟绝对路径。
四、 web广告栏(可以图片、动画、flash、表单等等)的一般大小
¨ 宽 高 说明
a) 468 60 完整广告栏
b) 392 72 带垂直导航条的完整广告条
c) 120 240 垂直广告栏
d) 234 60 半个广告栏
e) 125 125 方形广告栏
f) 120 90 按钮#1
g) 120 60 按钮#2
h) 88 31 微按钮
五、 脚本应用规则
a) 客户端使用JavaScript;
b) 服务器端如果使用ASP,则脚本使用VBScript;如果使用JSP,则脚本使用Java;
c) JavaScript编码规则
i. 变量和方法首单词全部用小写字母,后面其他首字母大写。
ii. 所有的变量都必须声明。
iii. 每行都必须用分号“;”结尾。
iv. 常用的一些函数归类,使用包含文件,举例:<script language="JavaScript" src="/include/html/string.js"></script>。
文 件 说 明
/include/html/form.js 与表单form有关的一些函数,如检查子段是否为空,检查Email格式等等。
/include/html/string.js 跟字符串处理有关的函数。
v.
d) ASP使用的VBScript编码规则
i. 变量首单词全部用小写字母,并且用三个字母来说明变量的类型,其他单词首字母要大写。举例:intCount,lngSum,dblSum,objConn……
ii. 所有过程和函数的单词首字母都必须大写。
iii. 尽量多使用包含文件,使显示与控制分开,实现模块化,举例:<!--#include virtual="/include/asp/standard.asp"-->。如有条件运行服务器端的COM组件就尽量使用服务器端的COM或COM+组件。常用的被包含文件如下表
文 件 说 明
/include/asp/standard.asp 每个asp文件都必须地一个包含的文件,其中定义了一些最常用的常量、变量和函数。
/include/asp/form.asp 定义了一些在表单处理中常用的常量、变量和函数。
/include/asp/dataBase.asp 定义了一些在数据库处理中常用的常量、变量和函数。譬如连结字符串的定义等。
/include/asp/xml.asp 定义了一些在XML处理中常用的常量、变量和函数。
六、 模板文件
a) 所有的文件都从模板文件开始,其中含有格式化的注释其中包括:作者、日期等等。
b) HTML的模板文件“/newFile.asp”
<!--#include virtual="/include/asp/standard.asp" -->
<!--#include virtual="/include/html/navigate.asp" -->
<% ShowHead "首页" %>
<!-- 在此出插入HTML -->
<!--#include virtual="/include/html/copyRight.asp" -->
</body>
</html>