常规ASP命名规则

 

ASP编码规范

一、 命名规则

1.        全局

所有缩写全部使用大写,比如:IDIPDB……

所有单词开头字母大写,比如:Request

 

2.        文件名:

文件名称统一用英文字母、数字和下划线的组合。

 

3.        变量名:

第一个单词的首字母小写,其后单词的首字母大写。

例子:intStartTimes

   变量名称前应该加类型标识:intTimes

类型:

1.       整形:int

2.       字符:str

3.       数组:arr

4.       布尔:bol

5.       浮点:flo

6.       对象:obj

7.       资源:res

8.       混合:mix

例子:

Se tobjDB = New MSSql()

arrList = array( a, b, c, … )

计数器用小写单字符,不用符合以上类型,一般是:ijmn

 

4.        常量名:

常理名统一全部大写,如果是多个单词组合的情况,使用下划线分隔开。

例子:PASSPORT_AUTH_KEY

 

5.        函数和过程名:

所有单词首字母大写,例如:

Function GetClientIP(Byval  a , Byref  b)

       Dim …….

End Function

 

6.        类名:

所有单词首字母大写,例如:

Class EliteMsSql()

      

End Class

7.        类方法名:

同函数命名,方法要求用Public声明。例如:

Class EliteMsSql()

       Public Sub AddMsg(strMsg)

              ………

       End Sub

End Class

私有方法前面加下划线。例如:

Private Function _GetIP()

       …….

End Function

 

8.        类属性名:

同类方法命名。

私有属性前面加下划线。

 

二、 程序块

1.        全局:

1.       括号内两边使用空格格开。

2.       运算符两端加空格:intA = 4

3.       函数名和括号之间不需要空格:Isarray( arr )

4.       连接号二边要加空格:A & B

5       其它语法和ASP语法要求一样:If expression Then

6.       TAL来排列程序块,使得整齐、美观、可读性高。

 

2.        IF语句:

If expression Then

       …….

              Else

                     …….

              End If

              IF 里面的程序块要内嵌一个TAB,有层次感。

              多个IF时,使用ElseIf而不是Else If

If expression Then

       …….

              ElseIf expression Then

                     …….

              Else

                     ……..

End If

ElseIf后面的语句遵从IF的规则

3.        SELECT语句:

Select Case ( expression )

       Case 1

              …….

       Case 2

              ……

       Case Else

              ……

              End Select

程序块要内嵌一个TAB,有层次感。

4.        FOR语句:

For i = 0 To 10

       ……

Next

For Each strLong In arrLong

       …….

Next

程序块要内嵌一个TAB,有层次感。

关键词的首位大写。

 

5.        WHILE类语句:

 

6.        包含语句:

注意要用空格:

<!-- #Include File = “file.asp” -->

 

7.        其它程序块:

 

三、 其它格式

1.        缩进:

使用制表符Tab缩进,长度为4个空格。(DW里默认为4个空格)

 

2.        注释:

ASP中注释只有“”。所以只能以逗号开头,后面带“//”两个斜杠。

要分隔程序块时,用“’*************”,用“逗号”开始带一串星号。不要用其它字符。

 

 

 

四、HTML格式

              1、全部小写。

2Tab缩进,层次分明。

3、按照XHTML要求来写。

      

五、CSS格式

             

             

六、JAVASCRIPT格式

              1、格式基本上和ASPHTML的差不多。

              2JS 是区分大写的,在命名和属性调用时需要注意。

3、需要注意的是大括号的写法。

以下写法是正确的:

if ( expression )

{

}

而不是

if ( expression ) {

}

单一expression

if ( expression )

{

}

多个expression

if ( ( expression ) && (expression2 ) )

{

}

使用elseif而不是else if

elseif后面的语句遵从if的规则。

流程控制里面的单行的语句可以这样写:

if ( expr )

    statement

else

    statement

for( expr )

    statement

但是不能:

if ( expr )

{

    statement

…….

}

else

    statement

上面代码必须写成:

if ( expr )

{

    statement

…….

}

else

{

    statement

}

             

七、还有其它的在实际用到再定。

             

 

总结:什么是好的代码

1)可读性很强的代码格式,能够区分不同的代码块

2)清晰明了的命名,在尽可能短的名称长度下传递足够多的信息

3)和代码相得益彰的注释(不要让注释重复代码所能表达的信息)

4)变量的生存期尽可能地短,这样阅读者不用去记大量的变量声明

5)使用小函数,将功能复杂的大函数进行分隔

总之,代码的好坏应该让别人是否能够容易读懂来区分,如果对自己的代码不满意,那么先给别人阅读,然后让阅读者告诉你他为什么读不懂,哪些地方读着吃力。好的代码应该能够让你在几个月后回顾自己的代码时一目了然(架构的清晰是代码易读的前提)。

原文地址:https://www.cnblogs.com/dj258/p/611766.html