哪里有asp方面的开发规范文档，高分相送

[goodlcp]

哪里有asp方面的开发规范文档，高分相送

[chenxingbai]

ASP代码规范标准
一、 一般代码规则 １
二、 常量变量的命名规则： ３
2.1 变量范围前缀 ３
2.2常量 ３
2.3变量数据类型 ４
2.4描述变量 ４
2.5用户定义的类型 ５
三、 ASP中对象的命名： ５
3.1推荐使用的数据访问对象 (ADO) 的前缀 ５
3.2推荐使用的文件访问对象 (FileSystemObject) 的前缀 ６
四、 函数和过程命名： ６
五、 模块化： ６
六、 消息使用参考： ７















一、 一般代码规则
l 每个ASP文件前必须加注释说明该程序做实现的功能以及是由谁编写的。
具体格式如下：
'**************************************************************************

' 文件名.........: Pub_PersonalFilesUp.asp
' 作者...........: flanker
' 说明...........: 个人档案资料上传
' 注意...........:
' 版权...........: Copyright (c) 2000, NerDragon Software.
' 修改记录.......: 时间 人员 备注
' --------- ------- -------------------------------------------
' 2001-08-02 flanker 创建文件
' 2001-08-02 flanker 修改文件
'**************************************************************************
l 数据库的连接字符串命名为strConnString，和其他的公共变量一起放在根目录下LIB目录的config.asp文件。
l 程序在编制过程、类或函数时要在该过程、类或函数前加上该过程、类或函数的说明，包括函数名称、功能描述、参数说明、返回值说明、修改日志。
具体格式如下：
' **************************************************************************
' # 函数：
' # 描述：
' # 参数： -
' # 返回：
' # 作者：
' # 日期：
' # 修改人：
' # 修改日期：
' **************************************************************************

' **************************************************************************
' # 过程：
' # 描述：
' # 参数： -
' # 返回：
' # 作者：
' # 日期：
' # 修改人：
' # 修改日期：
' **************************************************************************

功能说明描述的是该过程完成什么的简要说明，不必要说明是怎么完成。

l 每一个重要变量的声明应该包括一个嵌入注释，来描述该变量的使用。
l 在具体编程时两个不同功能的程序段之间应用一空行隔开以示区别，并且在该功能段前加上该功能段的功能说明，在重要的语句前也要加上说明，提高程序的可读性和可维护性。
l 函数内各功能模块，如：循环、流程的各分支等，尽可能多的加以注释。
l 注意错误处理。
用On Error Resume Next来屏蔽错误
用 IF Err.Number <> 0 Then
处理语句
End if
返回给用户一个友好的错误提示信息。
而不是出现HTTP 500-100错误
l 注意对变量类型和安全性的检查。
l 功能独立性原则。每一程序块只完成一个独立的功能，反过来，每一独立的功能只在一程序块内完成，尽量低耦合、高内聚。
l 少用及慎用全局变量原则,除非为了大幅度简化参数接口或增加程序可读性.。如果使用了全局变量，则全局变量必须能够反映全局意义且在引用处必须注释清除，局部变量避免与全局变量重名，不要显式返回全局变量（如return），全局变量最好不作为函数或过程的输入/输出参数，若确实有必要，应尽量将全局变量封装到函数或类中，减少其独立出现次数。
l 为保证语句结构的清晰和程序的可读性，在编写软件程序时应注意以下几个方面的问题：
◇ 宁可不要一些技巧也要保证程序的易读特性，不要因过分追求技巧而牺牲程序的可读性。
◇ 在一行内只写一条语句，并采用空格、空行和移行保证清楚的视觉效果。
如：
function table_del(id) {
var truthBeTold = window.confirm(" ");
if (truthBeTold)
{
window.location.href = "client_base_del.asp?Id=" + id ;
};
}
◇ 每一个嵌套的函数块，使用一个TAB缩进（可以设定为4个空格）。
◇ 文件之中不得存在无规则的空行，比如说连续十个空行。一般来讲函数与函数之间的空行为2-3行；在函数体内部，在逻辑上独立的两个函数块可适当空行，一般为1-2行。
◇ 每行长度尽量避免超过屏幕宽度，应不超过80个字符。
◇ 尽量用公共过程或子程序去代替重复的功能代码段。要注意，这个代码应具有一个独立的功能，不要只因代码形式一样便将其抽出组成一个公共过程或子程序。
◇ 使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。如将 x=a*b/c*d 写成 x=(a*b/c)*d可避免阅读者误解为x=(a*b)/(c*d)。
◇ 避免采用过于复杂的条件测试。
◇ 避免过多的循环嵌套和条件嵌套。
◇ 建议不要使用 *=，^=, /=等运算符。
◇ 一个函数不要超过200行。一个文件应避免超过2000行。
◇ 不要使用空的if else 语句。
◇ 不要在程序中直接使用数值，若需直接使用，则应该对该数值进行详细的说明用途。

二、 常量变量的命名规则：
原则上一定要申请变量，即在程序头加入：Option Explicit

变量的命名应遵从 变量名=作用域+“_”+变量类型+“_”+变量含义
2.1 变量范围前缀
随着工程大小的增长，划分变量范围的工作也迅速增加。在类型前缀的前面放置单字母范围前缀标明了这种增长，通过这一途径，代码中变量的作用域就变的清晰。
范围 前缀 例子
全局 g g_str_UserName
类成员或模块级 m m_bln_CalcInProgress
本地过程 无 Dbl_Velocity

2.2常量
常量名的主体是大小写混合的，每个单词的首字母大写。对于常量名，应遵循与变量相同的规则。例如：
m_int_UserListMax '对用户列表的最大限制
'(整数值，类成员或模块级)
g_str_NewLine '新行字符
'(字符串，应用程序全局使用)
2.3变量数据类型
用下列前缀来指明一个变量的数据类型。
Data type Prefix Example
Boolean bln bln_Found
Byte byt byt_RasterData
Currency cur cur_Revenue
Date (Time) dtm dtm_Start
Double dbl dbl_Tolerance
Error err err_OrderNum
Integer int int_Quantity
Long lng lng_Distance
Object obj obj_Current
Single sng sng_Average
String str str_FName
User-defined type udt udt_Employee
Variant vnt vnt_CheckSum

2.4描述变量
变量的主体应该使用大小写混合形式，并且应该足够长以描述它的作用。
对于频繁使用的或长的项，推荐使用标准缩略语以使名称的长度合理化。当使用缩略语时，要确保它们在整个应用程序中的一致性。在一个项目中，如果一会儿使用 Cnt， 一会儿使用 Count，将导致不必要的混淆。
变量含义：
接近变量含义的英文单词，如Meter 表示表底，Bill表示清单。若用个单词表示各个单词应用大写字母打头，如　MeterValue　表示表底值。
根据以上命名规则，我们对变量m_str_CallingNo应知道该变量是一个类的数据成员，该成员是字符串，存储的是主叫号码。这样我们就能望文生义，知道该变量的作用域、类型和含义，便于以后的维护和实际的编程。
2.5用户定义的类型
在一项有许多用户定义类型的大工程中，常常有必要给每种类型一个它自己的三个字符的前缀。如果这些前缀是以 "u" 开始的，那么当用一个用户定义类型来工作时，快速识别这些类型是很容易的。例如，ucli 可以被用来作为一个用户定义的客户类型变量的前缀。
注：对于非通用的变量，请在定义时加以注释说明，变量定义尽可能放在最开始处。
三、 ASP中对象的命名：
应该用一致的前缀来命名对象，使人们容易识别对象的类型。下面列出了 ASP 支持的一些推荐使用的对象约定。

3.1推荐使用的数据访问对象 (ADO) 的前缀
数据库对象 前缀 例子
Connection Conn Conn_Accounts
Recordset Rs Rs_Forecast
Command AdoCmd AdoCmd_Reports
Parameter AdoPrm AdoPrm_JobCode
Error AdoErr AdoErr dbeJet
Property AdoPro AdoPro_SalesReport
Field AdoFld AdoFld_Address
Stream AdoStm AdoStm_UpFile

3.2推荐使用的文件访问对象 (FileSystemObject) 的前缀
文件对象 前缀 例子
FileSystemObject Fso Fso_FileSysObj
Drive FsoDrv FsoDrv_Driver
File FsoFile FsoFile_File
Folder FsoFdr FsoFdr_Folder
TextStream FsoTs FsoTs_Fhandle


对于上面没有列出的对象，应该用唯一的由两个或三个字符组成的前缀使它们标准化，以保持一致性。只有当需要澄清时，才使用多于三个字符的前缀。

四、 函数和过程命名：
◇ 方法名/过程名通常使用动宾短语代表一定操作，建议使用英文。
例如，Sub FormatHardDrive

◇ 如果方法/过程无参数，通常使用set 作方法名前缀。
例如，Sub SetUserName

◇ 得到一个值的方法/过程，通常使用get 作方法名前缀
例如，Function GetUserName(string)
五、 模块化：
某一功能，如果重复实现两遍以上，即应考虑模块化，将它写成通用函数。并向小组成员发布。同时已要尽可能利用其它人的现成模块。模块化的一些注意事项：
1. 设计好模块接口，用面向对象的观点看，包括：函数接口和变量接口。
2. 定义好接口以后不要轻易改动，并在模块开头（文件的开头或函数的开头）加以说明。
3. 不要在外部使用接口以外的其它函数或变量。
4. 注意全局变量也是一种接口。
5. 接口即是罗列出一个模块的所有的与外部打交道的变量、函数等。

六、 消息使用参考：
文本消息，特别是消息框和警告对话框，必需适当地前后一致地反馈给用户。消息的使用以下几点是值得注意的：
◇ 避免使用专用的技术术语，使用礼貌用语；
◇ 消息语句要精练、简单扼要，但必需达意，限制2-3行；
◇ 避免在语气上有责备用户的语句；
◇ 避免使用缩写；
◇ 多行消息左对齐排列；
◇ 千万注意，消息中决不可有错别字或语法错误。