.NET开发规范.doc

.NET开发规范编写:审核:批准:目录1. 概述 52. 命名规范 . 类、参数和方法的命名规范 . 接口命名规范 . 动态语言文件命名规则 . 格式:性质_描述 . 客户端JavaScript规范 . 变量命名规范 . 对象命名规范 . 控件命名规范 . 图片的命名原则 . 数据库命名规范 . 命名规范原则 . 数据库规范 . 表命名规范 . 字段规范 . 视图规范 . 存储过程规范 . 函数规范 . 索引命名规范 . 关联命名 . 设计规范 93. 编码规范 . C#代码编写 . Request、Session、Application使用规范 . HTML标记语言编码规范 . 注释规范 . 异常规范 16概述为了保持应用程序、组件、文件的一致性,便于阅读和管理代码和结构,提高开发效率和产品的标准化,特制订一套开发规范和标准(包括命名规范和编码规范)。命名规范将包括:类和参数的命名规范、接口命名规范、数据库命名规范、ASP命名规范、JavaScript命名规范、控件命名规范等。编码规范将包括:C#编码规范、注释规范、HTML编码规范、编码规范、异常规范等。命名规范类、参数和方法的命名规范用名词或名词短语命名类。使用Pascal大写注记:Pascal大小写形式-所有单词第一个字母大写,其他字母小写。不要使用匈牙利命名法用有意义的,描述性的词语来命名变量-别用缩写。用name,address,salary等代替nam,addr,sal。-别使用单个字母的变量象i,n,x等。使用index,temp等。用于循环迭代的变量例外文件名要和类名匹配 自定义属性类时,以Attribute作为后缀自定义异常类时,以Exception作为后缀数据表的实体类以Entity作为后缀命名空间引用时,将系统自带的命名空间名放置一起,接着放置自定义的命名空间,最后放置第三方的命名空间所有成员变量应定义在类的前面,并和属性、方法空开一行且只能空开一行。当使用Partial类型且每一部分分配一个文件时,主文件以类名命名,后续加入的文件以类名加字母“Ex”加十进制数字序号(如果只有一个扩展类,不需要加数字,超过1个扩展文件,从2开始)命名。避免在一个文件中放置多个类。避免超过5个参数的方法。使用结构传递多个参数。局部变量和方法参数采用camel风格。接口命名规范使用名词或名词短语,或者描述行为的形容词来命名接口。例如,IComponent(描述性名词),ICustomAttributeProvider(名词短语),和IPersistable(形容词)。使用Pascal大写。减少接口名中缩写的使用量。不要使用带下划线的字符。在接口名前加前缀I,以表示这个类型是一个接口。不要在类名前加上前缀C。偶而情况下,需要在类名前加上I而并不表示它是一个接口。在这种情况下,只要I后面的字符是小写就可(例如,IdentityStore。)当类是接口的标准执行时,定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处只是接口名前有一个I前缀。下面我们举个例子,ponent和它的标准执行,类Component。ponent{}ponent:IComponent{}publicinterfaceIServiceProvider{}publicinterfaceIFormatable{}动态语言文件命名规则格式:性质_描述说明:描述可以有多个单词,用”_”隔开。性质一般是该页面的概要。范例:,,。各种类型的所写字符串如下:整型变量:int长整型变量:lng浮点型变量:flt双精度变量:dbl对象引用变量:obj字符串变量:strDate类型变量:dtm变量名必须采用有意义的单词命名,如:strUserName、lngArrayIndex变量名除首字母小写外,其他单词首字符必须大写对象命名规范各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀:text输入框:txtbutton按钮:btnselect下拉选择框:seloption项:optform表单:frmframe框架:frahidden表单项:hdndiv标记:divspan标记:spn对话框对象:dlg窗口对象:w