ASP代码设计的一些规范(一)

转载 2005年05月26日 16:46:00

ASP代码设计的一些规范(一)

任何一个项目或者系统开发之前都需要定制一个开发约定和规则,这样有利于项目的整体风格统一、代码维护和扩展。由于Web项目开发的分散性、独立性、整合的交互性等,所以定制一套完整的约定和规则显得尤为重要。

 

本文档将定制一系列约定和规则,他们分别包括:

组建团队、

文件夹命名规则、

文件名命名规则、

序代码编程风格、

数据库设计约定。

 

这些规则和约定需要与开发人员、设计人员和维护人员共同讨论定制,将来开发都将严格按规则或约定开发。每个团队开发都应有自己的一套规范,一个优良可行的规范可以使我们工作得心应手事半功倍,这些规范都不是唯一的标准不存在对与错,也许有些地方与你当前使用的习惯相驳,很多地方都有争议。比如很多人习惯设计数据库时采用自动增长字段,而有些人就坚决反对,各自都有比较充分的理由阐述自己的观点,所以只好根据具体情况来采用相应的策略。

 

非常明显在Web项目开发中有前后台开发之分,前台开发主要是指非程序编程部分,主要职责是网站AI设计、界面设计、动画设计等。而后台开发主要是编程和网站运行平台搭建,其主要职责是设计网站数据库和网站功能模板的实现。下面的这些规范主要是从这2个方面来定制的,本文档比较适合中小型网站或者Web项目的开发规范。

1.     组建开发团队   

在接手项目后的第一件事是组建团队。根据项目的大小团队可以有几十人,也有可以是只有几个人的小团队,在团队划分中应该含有6个角色,这6个角色是必须的,分别是

项目经理,

策划,

美工,

程序员,

代码整合员,

测试员。

也许你的团队还没有6个人,没有关系一个人可以有多个角色,比如项目经理还可以有策划这个角色,如程序员还可以含有代码整合和测试这2个角色,如果你的项目够大人数够多那就分为6个组,每个组分工再来细分。下面简单介绍一下这6个角色的具体职责。   

项目经理,项目总体设计,开发进度的定制和监控,定制相应的开发规范,负责各个环节的评审工作,协调各个成员(小组)之间开发。

策划,提供详细的策划方案和需求分析。还包括后期网站推广方面的策划。

美工,根据策划和需求设计网站AI,界面,Logo等。

程序员,根据项目总体设计来设计数据库和功能模块的实现。

代码整合员,负责将程序员的代码和界面融合到一起,代码整合员可以制作网站的相关页面,测试员,负责测试程序。

 

2.     开发工具

 Web开发工具主要分为3部分:

第一部分是网站前台开发工具,

第二部分是网站后台开发环境,

第三部分是项目管理和辅助软件。

网站前台开发主要是指Web界面设计。包括网站整体框架建立、常用图片、Flash动画设计等等,主要使用的相关软件是:Adobe Illustrator Adodb PhotoshopDreamweaver MXFlash MX等。   

网站后台开发主要指网站动态程序开发、数据库建模,主要使用的相关软件是: PowerDesigner(数据库建模),PowerDesigner在数据库设计方面应用非常强大,用它可以快速创建数据库概念和物理模型。Rational Rose(程序建模),如果你的项目功能模块不是特别复杂那就剩了它吧,这样会节省一些时间和开发的复杂度。

网站项目管理主要指对开发进度和代码版本的控制。开发进度用Microsoft Project来制定,代码版本控制采用Visual SourceSafe,当然还有其他的选择比如CVSRational ClearCase。网站测试采用VS.net的附带工具Microsoft Application Center Test,它可以进行并行、负载测试等。程序文档编写采用Word,如果你非常怀旧用WPS也可以。

 

3.     网站开发流程   

在项目开始实施之前应该有一个工作步骤也就是工作流程,在项目开发中最需要时间的是总体设计和系统测试,而程序编写代码所占的时间并不多,但有的团队就急于开发写代码,先把程序写出来再说,没有注重评审和测试这2个环节,结果造成返工。所以项目来了不要急于开工写代码,应该一步一步慢慢来,只有走的慢才能走得稳走得远。图1的开发流程比较好地体现开发的整个环节。 从图1可以看到2条主线,这2条主线分别是前台开发和后台开发。前后台开发在项目开发早期互相没有交叉,当然不是绝对没有,Web策划和需求分析都是互相有关系的,一个是网站表现形式和风格的策划另一个是网站功能的策划,它们是衣服和躯干的关系。到了开发后期就需要把界面和功能模块结合起来形成一个统一,也就即将发布的网站。

 

4.数据库开发

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

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

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

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

存储过程命名规则P_表名_存取过程名(缩写),比如P_User_DelP_ArticleType_AddData   

SQL语句编写规则,关键字必须大写,其他书写按上述命名规则,如:   SELECT user_id, user_name FROM User WHERE user_id = tom'

 

 

5.文件夹文件名命名规范

   文件夹命名一般采用英文,长度一般不超过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.aspregister_post.asp,topic_lock.asp

 

 

6.程序代码编程规范

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

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

2、       出于易读和一致性的目的,在代码中使用以下变量命名约定: 子类型 前缀 示例:

                                                    i.              Boolean bln blnFound

                                                   ii.              Byte byt bytRasterData

                                                 iii.              Date (Time) dtm dtmStart

                                                iv.              Double dbl dblTolerance

                                                 v.              Error err errOrderNum

                                                vi.              Integer int intQuantity

                                              vii.              Long lng lngDistance

                                             viii.              Object obj objCurrent

                                                ix.              Single sng sngAverage

                                                 x.              String str strFirstName   

 

3、       程序代码需要有缩进,缩进采用键盘Tab键,不采用空格键。并且""或者链接字符串时需要左右空一格。    

 

4、       函数过程编写的约定。函数或者过程命名采用动作+名词,每个函数需要给出相应的注释,函数功能,传入变量,以及作者和修改相关信息。如下面函数:   

<%  

‘[功能] 返回一个参数的值   

'[参数] strParameterName 参数名称   

'[作者] icefire 2002/8/20 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

相关文章推荐

ASP.NET Web开发框架之五 设计时支持,代码生成,数据字典 ExtAspNet控件扩展

当在Web页面中设计好表格布局之后,运用Enterpris Solution提供的框架,以可视化的方式绑定数据。 首先,请在配置文件中添加如下的程序集引用,以方便框架运用反射找到当前项目所引用的实体...

asp.net网站设计,忘记密码功能的代码实现?

string userID = this.userID.Text.Trim(); string newpwd = this.newpwd.Text.Trim();//新密码 ...

asp.net+MVC新的代码设计利器

下面文章介绍的一款叫狼奔的代码生成器 网站首页www.langben.com 同样感兴趣的朋友可以看看官方提供的视频,我这里提供一个我的网盘链接:点我去看视频 用下来给我的感觉非常好。 废话不...
  • armage
  • armage
  • 2012年12月29日 01:21
  • 245

代码编写规范说明书(c#.net与asp.net)

代码编写规范说明书(c#.net与asp.net) 目 录 1 目的 2 范围 3 注释规范 3.1 概述 3.2 自建代码文件注释 3.3 模块(类)注释 3.4 类属性注释 3...

ASP.NET 23种设计模式简单实例代码

  • 2011年09月13日 16:27
  • 347KB
  • 下载

ASP.NET留言本系统(含代码设计文档)

  • 2008年04月16日 18:08
  • 1.74MB
  • 下载

[ASP.NET] 基于.NET项目的代码书写规范要求书

第一章 主体命名规范  一、外挂服务命名规范  1) 服务项目命名  所有服务项目名使用ESrv(注意大小写)开头,第五位字母开始自订义,但是第五位字母必须大写。比如ESrvDemo1,其中...

购物网站设计 所有ASP.NET代码

  • 2009年10月23日 14:26
  • 2.73MB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:ASP代码设计的一些规范(一)
举报原因:
原因补充:

(最多只允许输入30个字)