NET开发规范

.NET开发规范编写：审核：批准：目录1.概述 (4)2.命名规范 (4)2.1.类、参数和方法的命名规范 (4)2.2.接口命名规范 (4)2.3.动态语言文件命名规则 (5)2.3.1.格式：性质_描述 (5)2.4.客户端JavaScript规范 (5)2.4.1.变量命名规范 (5)2.4.2.对象命名规范 (5)2.5.控件命名规范 (6)2.6.图片的命名原则 (6)2.7.数据库命名规范 (7)2.7.1.命名规范原则 (7)2.7.2.数据库规范 (7)2.7.3.表命名规范 (7)2.7.4.字段规范 (8)2.7.5.视图规范 (8)2.7.6.存储过程规范 (8)2.7.7.函数规范 (8)2.7.8.索引命名规范 (8)2.7.9.关联命名 (8)2.7.10.设计规范 (8)3.编码规范 (8)3.1.C#代码编写 (8)3.2.Request、Session、Application使用规范 (12)3.3.HTML标记语言编码规范 (12)3.4.注释规范 (12)3.5.异常规范 (15)1.概述为了保持应用程序、组件、文件的一致性，便于阅读和管理代码和结构，提高开发效率和产品的标准化，特制订一套开发规范和标准（包括命名规范和编码规范）。

命名规范将包括：类和参数的命名规范、接口命名规范、数据库命名规范、ASP命名规范、JavaScript命名规范、控件命名规范等。

编码规范将包括：C#编码规范、注释规范、HTML编码规范、编码规范、异常规范等。

2.命名规范2.1.类、参数和方法的命名规范2.1.1.用名词或名词短语命名类。

2.1.2.使用Pascal大写注记：Pascal大小写形式－所有单词第一个字母大写，其他字母小写。

2.1.3.不要使用匈牙利命名法2.1.4.用有意义的，描述性的词语来命名变量-别用缩写。

用name,address,salary等代替nam,addr,sal。

-别使用单个字母的变量象i,n,x等。

使用index,temp等。

用于循环迭代的变量例外2.1.5.文件名要和类名匹配2.1.6.自定义属性类时，以Attribute作为后缀2.1.7.自定义异常类时，以Exception作为后缀2.1.8.数据表的实体类以Entity作为后缀2.1.9.命名空间引用时，将系统自带的命名空间名放置一起，接着放置自定义的命名空间，最后放置第三方的命名空间2.1.10.所有成员变量应定义在类的前面，并和属性、方法空开一行且只能空开一行。

2.1.11.当使用Partial类型且每一部分分配一个文件时，主文件以类名命名，后续加入的文件以类名加字母“Ex”加十进制数字序号（如果只有一个扩展类，不需要加数字，超过1个扩展文件，从2开始）命名。

2.1.12.避免在一个文件中放置多个类。

2.1.13.避免超过5个参数的方法。

使用结构传递多个参数。

2.1.14.局部变量和方法参数采用camel风格。

2.2.接口命名规范使用名词或名词短语，或者描述行为的形容词来命名接口。

例如，IComponent（描述性名词），ICustomAttributeProvider（名词短语），和IPersistable（形容词）。

使用Pascal大写。

减少接口名中缩写的使用量。

不要使用带下划线的字符。

在接口名前加前缀I，以表示这个类型是一个接口。

不要在类名前加上前缀C。

偶而情况下，需要在类名前加上I而并不表示它是一个接口。

在这种情况下，只要I后面的字符是小写就可（例如，IdentityStore。

）当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。

两个名称的不同之处只是接口名前有一个I前缀。

下面我们举个例子，来看看接口IComponent和它的标准执行，类Component。

public interface IComponent{}public class Component:IComponent{}public interface IServiceProvider{}public interface IFormatable{}2.3.动态语言文件命名规则2.3.1.格式：性质_描述说明：描述可以有多个单词，用”_”隔开。

性质一般是该页面的概要。

范例：register_form.asp，register_post.asp，topic_lock.asp2.4.客户端JavaScript规范2.4.1.变量命名规范2.4.1.1.常量以及全局变量名必须全部使用大写字母2.4.1.2.变量名首字母必须小写2.4.1.3.变量名必须使用其类型的所写字符串开始。

各种类型的所写字符串如下：2.4.1.4.整型变量：int2.4.1.5.长整型变量：lng2.4.1.6.浮点型变量：flt2.4.1.7.双精度变量：dbl2.4.1.8.对象引用变量：obj2.4.1.9.字符串变量:str2.4.1.10.Date类型变量：dtm2.4.1.11.变量名必须采用有意义的单词命名，如：2.4.1.12.strUserName、lngArrayIndex2.4.1.13.变量名除首字母小写外，其他单词首字符必须大写2.4.2.对象命名规范2.4.2.1.各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀：2.4.2.2.text输入框:txt2.4.2.3.button按钮：btn2.4.2.4.select下拉选择框：sel2.4.2.5.option项:opt2.4.2.6.form表单：frm2.4.2.7.frame框架：fra2.4.2.8.hidden表单项：hdn2.4.2.9.div标记：div2.4.2.10.span标记:spn2.4.2.11.对话框对象:dlg2.4.2.12.窗口对象：wnd2.5.控件命名规范建议是使用控件名简写作为前缀，并且简写的首字母小写，并且整个名字符合Camel规范。

控件命名格式：控件名简写前缀+英文描述注意：英文描述中的单词首字母大写主要控件名简写对照表控件名简写Label lblTextBox txtButton btnCheckBox chkRadioButton rdoCheckBoxList chklstRadioButtonList rdolstListBox lstDropDownList ddlDataGrid dgDataList dlImage imgTable tblPanel pnlLinkButton lnkbtnImageButton imgbtnCalender cldAdRotator arRequiredFieldValidator rfvCompareValidator cvRangeValidator rvRegularExpressionValidator revValidatorSummary vsCrystalReportViewer rptvew2.6.图片的命名原则2.6.1.格式：名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质，例如广告、标志、菜单、按钮等等。

2.6.2.放置在页面顶部的广告、装饰图案等长方形的图片取名：banner2.6.3.标志性的图片取名为：logo2.6.4.在页面上位置不固定并且带有链接的小图片我们取名为button2.6.5.在页面上位置固定并且不带有链接的背景图片我们取名为backimg2.6.6.在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menu2.6.7.装饰用的照片我们取名：pic2.6.8.不带链接表示标题的图片我们取名：title2.6.9.范例：banner_sohu.gif、banner_sina.gif、menu_aboutus.gif、menu_job.gif、title_news.gif、logo_police.gif、logo_national.gif、pic_people.jpg、backimg_notes。

2.7.数据库命名规范2.7.1.命名规范原则2.7.1.1.只针对数据库、表、字段、视图、存储过程以及变量的命名规范标准2.7.1.2.旧有的数据表的命名规范不作调整，遵循原有的习惯2.7.1.3.新的数据库设计必须遵循该命名规范2.7.1.4.由于命名规范定义完成比较匆忙，还有很多考虑未周，待以后细节进行补充定义。

2.7.1.5.对于设计规范需要补充的内容较多，会进一步完善。

2.7.2.数据库规范2.7.2.1.数据库命名以公司名称Sunivo+应用程序名称的英文单词或缩写组合2.7.2.2.应用程序名称单词第一个字母要大写，如：SunivoSupplyCashBalance,SunivoSupCash 2.7.3.表命名规范2.7.3.1.表名称易于理解，准确表达其表功能的英文单词或缩写的英文单词2.7.3.2.如果当前表需要用两个或两个以上的单词来表示，尽量以完整的形式表述，如太长可采用两个单词的缩写形式例如：客户物料表，Sys_CustItem2.7.3.3.按模块功能分类，标识前缀模块名称前缀公用Pub公用的系统块Pub_Sys公用的日志块Pub_Log核心产品Core字典DD英文前台En中文前台Cn供应商ProviderReach Reach人事管理Hr现金流Cash基础Bas销售Sunivo改为Sale采购Sunivo改为：Stock物流Wl财务Sunivo改为：Finance报表Rpt其它Oth2.7.3.4.命名表时，用单数形式表示。

例如：Employee，而不使用Employees2.7.3.5.对于主明细表的，明细表名称为：主表的名称+字符Detail。

例如：订单En_Order，其明细为：En_OrderDetail2.7.3.6.后台表名尽量与前台表名一致，不区分前后台应用。

2.7.4.字段规范2.7.4.1.采用有意义的字段名，字段名称必须易于理解2.7.4.2.不建议采用”_”的方式进行字段的分段2.7.4.3.主键的内码字段，统一标识，取为：ID，采用整型或长整型2.7.4.4.命名字段时，不要重复表的名称。

例如：Employee表中的字段名不要命名为，EmployeeLastName2.7.4.5.不要在字段名称中包括数据类型。

2.7.5.视图规范2.7.5.1.前缀加VW2.7.5.2.其它的遵循表的命名规范2.7.6.存储过程规范2.7.6.1.前缀加UP2.7.6.2.其它的遵循表的命名规范2.7.7.函数规范2.7.7.1.前缀加UF2.7.7.2.其它的遵循表的命名规范2.7.8.索引命名规范2.7.8.1.索引格式为：IX_+表名+字段名。