网站开发命名详细规范

前 言 

 

良好的命名规范可以为团队合作开发推波助澜，无论在项目开发，还是产品维护上都起到了至关重要的作用。应该说命名规范是一种约定，也是程序员之间良好沟通的桥梁。另外古人相信只要知道一个人真正的名字就会获得凌驾于那个人之上的不可思议的力量。只要给事物想到正确的名字，它就可以带来比代码更强的力量。如果所有的命名都与其自然相适合，则关系清晰，含义可以推导得出，一般人的推想也能在意料之中。  

注：常用英文关键字见附录： 《天行健网站开发文件命名规范关键字词典》  

 

一、文件夹命名规则  

 

文件夹命名一般采用英文，长度一般不超过20个字符，命名采用小写字母。一些常见的文件夹命名如：images(存放图形文件)，flash（存放Flash文件），style(存放CSS文件)，scripts（存放javascript脚本），inc(存放include文件)，link（存放友情链接）,media(存放多媒体文件)等。  

 

二、文件命名规则  

 

文件名称统一用小写的英文字母、数字和下划线的组合，以英文字母开头。命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作 。  

1. 图片的命名原则名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质例如广告、标志、菜单、按钮等等。  

放置在页面顶部的广告、装饰图案等长方形的图片取名： banner  标志性的图片取名为： logo 

在页面上位置不固定并且带有链接的小图片我们取名为 button  

在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名： menu 装饰用的照片我们取名： pic  

不带链接表示标题的图片我们取名： title  

下面是几个范例： banner_sohu.gif 、banner_sina.gif、 menu_aboutus.gif 、menu_job.gif、 title_news.gif、 logo_police.gif、 logo_national.gif 、pic_people.jpg 。  

2. 动态语言文件命名规则性质_描述，描述可以有多个单词，用”_”隔开，性质一般是该页面得概要。 

范例：register_form.asp，register_post.asp,topic_lock.asp  

 

三、程序代码编程规范 

 

一个良好的程序编码风格有利于系统的维护，代码也易于阅读查错。在此只讨论ASP的编程风格和约定。在ASP中所有变量是弱变量，无需定义就可以直接使用，而且代码不区分大小写。但其他语言一般这些都要定义的，为了养成良好的编程习惯，编写代码务必按照一下规则。  

1. 每个变量名必须定义，在ASP文件的最开始添加语句，强制定制每个变量。  

2. 出于易读和一致性的目的，在代码中使用以下变量命名约定：    

子类型    前缀    示例      

Boolean   bln     blnFound      

Byte      byt     bytRasterData      

Date      (Time)  dtm    dtmStart      

Double    dbl     dblTolerance      

Error     err     errOrderNum      

Integer   int     intQuantity      

Long      lng     lngDistance      

Object    obj     objCurrent      

Single    sng     sngAverage      

String    str     strFirstName     

3. 程序代码需要有缩进，缩进采用键盘Tab键，不采用空格键。并且”＝”或者链接字符串时需要左右空一格，如下： <% 

  strMessage = “你好” 

  strMessage = strMessage & “欢迎你访问Aspid”   %> 

4. 函数过程编写的约定。函数或者过程命名采用动作+名词，每个函数需要给出相应的注释，

函数功能，传入变量，以及作者和修改相关信息。如下面函数:

    <% '[功能] 返回一个参数的值 

       '[参数] strParameterName 参数名称

       '[作者] qingis 2005/7/29 am 

      Function GetParameterValue(strParameterName)

           Dim objRS, strSQL, strParameterValue 

           strSQL = "SELECT ParameterValue FROM damsParameters WHERE ParameterName = '" &    strParameterName & "'"             .

            .

            . 

          GetParameterValue = strParameterValue

          Set objRS = Nothing

      End Function %>

5. ASP内置对象区分大小写。如下代码片断

      strUserName = Request.Form(“UserName”) 

      Set conn = Server.CreateObject("ADODB.Connection")  

6. 数据库连接一个库只能有一个数据库连接文件，创建数据库对象的原则是尽可能晚地打开数据库，尽可能早地关闭数据库。创建数据库对象调用统一地创建函数。如下：

   Sub OpenConn(ByRef conn) 

       Dim strDBPath, strDBConnection  

       strDBPath = Server.MapPath("database/tax.mdb") 

       strDBConnnection = "Driver={Microsoft Access Driver (*.mdb)}; DBQ=" & strDBPath    

       Set conn = Server.CreateObject("ADODB.Connection")    conn.Open strDBConnnection   

   End Sub  

7. 当一个对象不在使用时要释放对象资源，比如objFSO,objRS对象等。采用统一函数调用。函数如下： 

      Sub CloseObj(ByRef obj)

        If IsObject(obj) Then

         obj.Close 

         Set obj = nothing

        End If

      End Sub  

8. 时间全部以字符串的形式保存到数据库中，这样做能够是日期在不同的数据库中都能良好地保存，也方便数据库地迁移。时间用14位字符串保存，日期用8位字符串保存。  

 

四、数据库命名规范 

 

数据文件命名采用"系统名_文件名"类型，比如系统名为aspid,则数据库文件命名为aspid_database.mdf，有的数据库文件有多个，比如SQL Server就有2个，一个是数据库文件，另一个是日志文件，那么他们的文件命名分别为aspid_database.mdf，aspid_log.log。文件名全部采用小写。  

数据库表命名规范，表名长度不能超过30个字符，表名中含有单词全部采用单数形式，单词首写字母要大写，多个单词间不用任何连接符号。若库中有多个系统，表名采用系统名称+单词或多个单词，系统名是开发系统的缩写，系统名称全部采用小写英文字符,如bbsTitle,bbsForumType。若库中只含有一个系统，那么表名仅用一个单词或多个单词。单词选择能够概括表内容的一个或多个英文单词，如UserInfo,UserType。关连表命名规则为Re_表A_表B,Re是Relative的缩写，如：Re_User_ArticleType, Re_User_FormType。  

数据库字段命名规范，数据库字段名全部采用小写英文单词，单词之间用”_”隔开，命名规则是表别名+单词，如：user_name,user_pwd。表别名规则，如果表名是一个单词，别名就取单词的前4 个字母；如果表名是两个单词，就各取两个单词的前两个字母组成4 个字母长的别名；如果表的名字由3 个单词组成，你不妨从头两个单词中各取一个然后从最后一个单词中再取出两个字母，结果还是组成4 字母长的别名。  

视图名采用规则View_表A_表B_表C,View表示视图。这个视图由几个表产生就用”_”连接几个表的名，如果表过多可以将表名适当简化，但一定要列出所有表名。  

存储过程命名规则P_表名_存取过程名(缩写)，比如P_User_Del，P_ArticleType_AddData。 SQL语句编写规则，关键字必须大写，其他书写按上述命名规则，比如： SELECT user_id, user_name FROM User WHERE user_id = 'tom'