rustysun同学ASP代码书写规范

ASP代码书写规范指南

一、规范简介

本指南旨在规范ASP源程序的书写，确保开发人员在编写代码时遵循统一的标准。这将增强代码的可读性，促进团队合作，并方便后续的维护和二次开发。

二、一般格式规范

1. 缩进：为提高代码的可读性，应使用两个空格进行缩进。每一级的缩进为四个空格。严禁使用Tab键，因为Tab的效果会因用户设置不同而产生差异。在进入判断、循环、With语句、函数、过程、类声明时增加一级缩进，退出时减少一级。

2. 换行：在判断、循环、With语句的起始与结束时换行，函数、过程、类的声明结束时也要换行。这有助于增强代码的可读性和调试。

3. 空格：操作符及逻辑判断符号两端应添加空格。例如，在赋值、连接字符串或逻辑判断时。但在添加括号时不需要空格。

三、VBScript语法书写格式规范

1. 保留字：VBScript的保留字或关键词应全部使用第一个字母大写，其余字母小写的原则（推荐）。也可以采用全部小写的方式，以方便输入源程序。

2. 过程和函数：过程和函数的名称应使用有意义的英文单词组成。第一个单词全部小写，其它单词的首字母使用大写字母。设置变量内容的过程和函数，应以“set”作为前缀；读取变量内容的过程和函数，应以“get”作为前缀。

3. 参数：所有参数名称必须是有意义的，参数命名采用同义的英文。参数名前加前缀‘a_’，后跟参数的类型（如String为s，Integer为i等），必须小写，然后接参数名，单词的第一个字母大写。

4. 变量：变量命名应采用有意义的英文命名，可以使用几个英文单词，但每个单词的首字母必须大写。为了增强代码可读性，建议在变量名中体现变量类型。虽然ASP中不需要声明变量类型，但添加类型描述前缀是一个好的实践。

四、注意事项

在遵循以上规范的还需注意以下几点：

1. 尽量避免使用过于复杂或冗长的代码结构，保持代码的简洁性和易读性。

2. 注释是代码的重要组成部分，务必对关键部分和复杂逻辑进行注释说明。

3. 在可能的情况下，遵循面向对象的设计原则，以提高代码的可维护性和可扩展性。

4. 对于外部引入的库、组件等，应详细记录并说明其用途和依赖关系。

变量命名规范：

整型变量可以简写为 `i`，例如 `iCount`。

短整型可以简写为 `sh`，长整型可以简写为 `l`。

单精度型可以命名为 `sn_变量名`，双精度型可以命名为 `db_变量名`。

字节型可以简写为 `by`，字符型可以简写为 `c`，字符串型可以简写为 `s`。

二进制型可以简写为 `bn`，布尔型可以简写为 `b`。

日期时间型可以简写为 `d`。

循环控制变量通常使用单一的字符如 `i`, `j`, `k`，同时也可以使用有意义的名字，如 `iUserIndex`。

全局变量与类级变量：

尽量避免使用全局变量。如果必须使用，变量名称前必须加前缀 `gbl_`，并在变量名称中体现其类型。

类级变量是指在Class中，对整个Class内部所有的属性和方法都起作用的变量。使用时需加前缀 `cls_`，并在变量名称中体现其类型。例如 `cls_iFileName`。

类和表单的命名规范：

类的名字必须有意义，且名字之前要加前缀 `T`。例如 `Class TUpload ... End Class`。类实例的名字通常是去掉前缀 `T` 的形式。例如 `Dim oUpload: oUpload=new TUpload`。

表单及表单项的命名应该有意义，并使用类型简写作为前缀。例如，表单可以简写为 `frm`，文本框可以简写为 `txt`，复选框为 `chk` 等。

文件和目录结构规范：

程序主目录下应包含Web、DB、Doc、Help、Backup和Temp等子目录。

文件命名必须使用有意义的名字，并可以在文件头部写明文件的用途、作者、修改日期和修改历史。例如，一个录入用户资料表单的文件名可能是 `frmAddUser.asp`，而一个向数据库中录入用户资料的文件名可能是 `addUser.asp`。

修改规范：

对于已经纳入配置管理的程序进行修改时，需要保留修改前的内容，并标识出修改和新增的内容。

在源文件头部加入修改历史项，包括修改人、修改日期和修改说明等信息。

新增代码行的前后应有注释行说明，删除代码行的前后也用注释行说明。修改代码行时，需要先注释掉原代码，再新增修改后的代码。例如：`(修改人 cjj 修改时间 2023-06-09 修改说明 新增功能) 新增代码行 (修改人 cjj 修改时间 2023-06-09 修改结束)`。这样可以让其他开发者明白代码的变动原因和变动内容。这个规则有助于代码的可读性和可维护性。同时也有助于开发者之间的交流与合作。在软件开发过程中保持一致的编码规范是非常重要的，它可以提高代码质量、减少错误并提升团队的协作效率。因此遵循这些编程规范是每位开发者的职责之一。这样可以保证我们的项目在持续的开发和维护过程中保持清晰和稳定的状态。