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.1

3.避免超过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.asp

2.4.客户端JavaScript规范

2.4.1.变量命名规范

2.4.1.1.常量以及全局变量名必须全部使用大写字母

2.4.1.2.变量名首字母必须小写

2.4.1.

3.变量名必须使用其类型的所写字符串开始。各种类型的所写字符串如下：

2.4.1.4.整型变量：int

2.4.1.5.长整型变量：lng

2.4.1.6.浮点型变量：flt

2.4.1.7.双精度变量：dbl

2.4.1.8.对象引用变量：obj

2.4.1.9.字符串变量:str

2.4.1.10.Date类型变量：dtm

2.4.1.11.变量名必须采用有意义的单词命名，如：

2.4.1.12.strUserName、lngArrayIndex

2.4.1.1

3.变量名除首字母小写外，其他单词首字符必须大写

2.4.2.对象命名规范

2.4.2.1.各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀：2.4.2.2.text输入框:txt

2.4.2.

3.button按钮：btn

2.4.2.4.select下拉选择框：sel

2.4.2.5.option项:opt

2.4.2.6.form表单：frm

2.4.2.7.frame框架：fra

2.4.2.8.hidden表单项：hdn

2.4.2.9.div标记：div

2.4.2.10.span标记:spn

2.4.2.11.对话框对象:dlg

2.4.2.12.窗口对象：wnd