页面文件结构
依次为代码头,变量定义,参数接收及有效性判断,创建的对象,数据库操作,JavaScript,Html
1. 代码头
记录文件功能和版本变化情况,修改他人文件,需重新定义版本信息并注明修改原因
‘***********************************************************
‘功能:×××××××××××××
‘版本:
‘ v1.00 ××× 2005.03.05
‘ v1.01 ××× 2005.03.16 修改原因
‘ v1.10 ××× 2005.03.31 修改原因
‘***********************************************************
2. 变量定义
由于在ASP和VBSCRIPT中不需要声明变量,同时不能声明变量的类型,对于本系统开发的变量命名统一规则,虽然有时候比较麻烦,但是,能养成好的开发习惯,它大大提高了程序的可读性,见其变量命名就知其意。在做变量查找的时候也比较方便。
常量定义统一在const文件中,例Const ci_PageSize = 10 ‘**定义分页记录数,其中c表明是常量,i表明了数据类型,PageSize表明了用途(首字母大写),为了容易理解,尽量使用英文单词来代替,尽量避免使用缩写或简写,在变量定义后面最好加变量功能定义的注释
变量定义用l开头(local),例Dim ls_UserID ‘**用户编号
数据类型说明:
a、 整型: i
b、 单精度实体变量: f
c、 双精度实体变量: d
d、 字符型变量: s
e、 布尔型变量:b
f、 数组变量:ar
3. 参数接收及有效性判断
接收参数用自定义的request防注入函数,并对必要参数作是否为空的有效性判断
4. 创建的对象
组件的实例化,为节省开销故放在参数有效性检查后面
5. 数据库操作
对于SQL语句,存储过程,尽量避免使用*来取所有字段,为了代码的易读性,SQL关键字全部大写
复杂的尽量用存储过程,并用函数封装
最后及时释放对象,即Set 对象变量名=Nothing
6. JavaScript
7. Html
页面风格全部通过样式表实现
路径全部采用相对路径
一个网页要尽量避免用整个一张大表格,因为浏览器在解释页面的元素时,是以表格为单位逐一显示,那么很可能浏览者要先面对一片空白很长时间,然后网页内容同时出现。如果必须这样做,请使用 <tbody>标记,以便能够使这个大表格分块显示
为了能够与下一代的web 语言xml 标准兼容,所有的HTML 标签的属性都要用单引号或者双引号括起,即我们应该写 <a href=”url”> 而不是 <a href=url>,特别是有属性Value的值,如果数据库中出来的值有空格,空格后面还有值,结果,显示的内容只有空格前面的内容,而后面的内容就会丢失
文件命名
文件名称统一用小写的英文字母、数字和下划线的组合,尽量用英文缩写,杜绝拼音。
命名原则是使自己和其他同事能够方便的理解每一个文件的意义,当我们在文件夹中使用“按名称排列”时,同一模块的文件能够排在一起,便于查找。
例如sys_user_list.asp。代表系统维护功能中操作员维护模块的列表页面
代码缩进
为了提高代码的美观型和易读性,以一个Tab(4个空格)为间距。
代码注释
为了提高代码的可读性,尽量多写注释。
修改他人文件的版本注释(对应代码头的版本注释),原则上保留每次修改的痕迹
删除单行:
××××××××××××× ’** v1.01 del
删除多行:
’** v1.01 del start
’**×××××××××××××
’**×××××××××××××
’** v1.01 del end
新增单行:
××××××××××××× ’** v1.01 add
新增多行:
’** v1.01 add start
’**×××××××××××××
’**×××××××××××××
’** v1.01 add end