我的asp编码规范

由于asp默认的脚本语言vbscript不区分大小写以及书写asp的编辑器很少带有asp代码格式化功能，结果是我们下载一个asp源代码后发现代码极其晦涩难懂，代码毫无美观可言。而反观国外的一些使用asp编写的代码则比较注重这方面，代码的大小写，变量命名，缩进，注释等等，代码优美易读容易上手。

不多说废话了，说下我自己使用asp开发时候的编码规范吧。

1.变量名称采用有意义且尽量易懂的英文单词或组合，采用驼峰式命名规则，定义全局变量时最好使用完整的单词并与局部变量能够区分开，定义局部变量则可以采用较简短单词。

例如：

定义读取全局登录会员用户名的变量：

Dim gUserName : gUserName  = Session("userName")

在函数中定义局部变量则可以采用 Dim i之类定义

2.vbs自带函数、语句等首字母使用大写

如Dim, Sub,Function ,For..To..,Do While Not..

3.代码缩进采用缩进2个空格，采用空格而不是tab的好处就是在任何编辑器和缩进设置下看到的代码编排效果效果都相同。缩进太多则整行过长导致阅读不便。

示例如下：

For i=0 To Ubound(arr)

  If i>5 Then Exit For

  Response.Write(arr(i))

Next

4.关于注释在网上搜索了一下刚好有c#的编码规范比较合适直接套用过来吧

·                               修改代码时，总是使代码周围的注释保持最新。

·                               在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍。

·                               避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。

·                               避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。

·                               避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。

·                               在部署之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。

·                               如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。

·                               在编写注释时使用完整的句子。注释应该阐明代码，而不应该增加多义性。

·                               在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。

·                               避免多余的或不适当的注释，如幽默的不主要的备注。

·                               使用注释来解释代码的意图。它们不应作为代码的联机翻译。

·                               注释代码中不十分明显的任何内容。

·                               为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。

·                               对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。

·                               在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。

·                               用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。