黔港南信息
ASP 代码规范标准
目录 ASP 代码规范标准 .......................................................................................................................... 1 目录 .................................................................................................................................................. 1 一、 一般代码规则................................................................................................................... 1 二、 常量变量的命名规则:................................................................................................... 3 常量变量的命名规则: 三、 ASP 中对象的命名: ...................................................................................................... 4 中对象的命名: 四、 函数和过程命名: 函数和过程命名:........................................................................................................... 5 五、 模块化: 模块化:........................................................................................................................... 5 六、 消息使用参考: 消息使用参考:............................................................................................................... 6
一、
一般代码规则
每个 ASP 文件前必须加注释说明该程序做实现的功能以及是由谁编写的。 具体格式如下: '************************************************************************** ' 文件名.........: Pub_PersonalFilesUp.asp ' 作者...........: flanker ' 说明...........: 个人档案资料上传 ' 注意...........: '
版权...........: Copyright (c) 2000, NerDragon Software. ' 修改记录.......: 时间 人员 备注 ' --------------- ------------------------------------------' 2001-08-02 flanker 创建文件 ' 2001-08-02 flanker 修改文件 '************************************************************************** 数据库的连接字符串命名为 strConnString, 和其他的公共变量一起放在根目录下 LIB 目 录的 config.asp 文件。 程序在编制过程、类或函数时要在该过程、类或函数前加上该过程、类或函数的说明, 包括函数名称、功能描述、参数说明、返回值说明、修改日志。 具体格式如下: ' ************************************************************************** ' # 函数: ' # 描述:
-1-
黔港南信息
' # 参数: ' # 返回: ' # 作者: ' # 日期: ' # 修改人: ' # 修改日期: ' ************************************************************************** ' ************************************************************************** ' # 过程: ' # 描述: ' # 参数: ' # 返回: ' # 作者: ' # 日期: ' # 修改人: ' # 修改日期: ' ************************************************************************** 功能说明描述的是该过程完成什么的简要说明,不必要说明
是怎么完成。 每一个重要变量的声明应该包括一个嵌入注释,来描述该变量的使用。 在具体编程时两个不同功能的程序段之间应用一空行隔开以示区别, 并且在该功能段前 加上该功能段的功能说明,在重要的语句前也要加上说明,提高程序的可读性和可维护性。 函数内各功能模块,如:循环、流程的各分支等,尽可能多的加以注释。 注意错误处理。 用 On Error Resume Next 来屏蔽错误 用 IF Err.Number <> 0 Then 处理语句 End if 返回给用户一个友好的错误提示信息。 而不是出现 HTTP 500-100 错误