C系统开发规范.doc

青岛福莱易通 C#系统开发规范 徐震 2013-1-11 版 本 历 史 版本号 作者 文档操作 编写日期 备注 1.0 徐震 新建 2013-1-11 创建文档。 1.1 徐震 编辑 2013-2-19 加入控件命名规范。 目录 一、命名规范 3 1.1、数据库命名规范 3 1.2、编码命名规则和风格 3 1.3、编码实践 4 1.4 控件命名规则 9 一、Data Control 9 二、Validation Control 9 三、Navigation Control 10 四、Login Control 10 五、WebParts Control 10 六、基本数据类型 11 七、ADO.NET 命名规范 11 八、WinForm Control 命名规范 12 九、WebControl 命名规范 12 二、开发规范 14 2.1网站开发规范 14 2.2日志访问规范 14 一、命名规范 1.1、数据库命名规范 数据库名称采用英文或中文简拼 数据表名称：系统简拼_表用途_业务处理 主键名称：PK_表名 外健名称：FK_表名 例如：Tb_Corp_CompanyInfo，系统简拼_企业_企业详细信息 视图名称定义：V_子系统简拼_视图用途 存储过程名称：Proc_子系统简拼_存储过程用途 过程中的开始必须写明参数、用途、和实现的业务，并在其中的判断循环等逻辑环节注明注释 用户自定义的函数名称：Func_子系统简拼_函数用途 1.2、编码命名规则和风格 类、方法、常量采用Pascal风格命名 public class SomeClass { const int DefaultSize = 100; public SomeMethod() { } } 成员变量采用Camel风格命名public class SomeClass { int _port = 5000; public SomeMethod() { } } 局部变量和方法参数采用Camel风格命名public class SomeClass { public SomeMethod(int len) { string sLine; } } 接口采用作为前缀命名interface IMyInterface { } 自定义属性类型以Attr作为后缀命名自定义异常类型以Ex作为后缀命名采用动命名方法，例如ShowDialog()有返回值的方法的命名应该能够描述其返回值，例如GetObjectState()采用描述性的变量名。 a) 避免采用单字母的变量名，如i或t；而是采用index或temp对public和protected成员避免采用匈牙利命名法 c) 尽量不要采用缩写（例如将number缩写为num）总是使用C#预定义的类型，而不是使用System命名空间中的别名 例如：采用object不用Object 采用string不用String 采用int不用Int32在使用泛型的时候，类型的首字母要大写。当处理.NET中的Type类型的时候，保留Type后缀。(C#2.0新特性)// 正确方法： public class LinkedListK,T {……} // 避免使用： public class LinkedListKeyType,DataType {……} 采用有意义的命名空间名，例如产品名称或公司名称避免使用类的全称，而是采用using声明避免在命名空间内使用using语句把所有系统框架提供的名称空间组织到一起，把第三方提供的名称空间放到系统名称空间的下面using?System; ?? using?System.Collection.Generic; ?? using?System.ComponentModel; ?? using?System.Data; ? using?MyCompany; ? using?MyControls; 使用代理推导而不要显式的实例化一个化代理（C#2.0新特性）delegate?void?SomeDelegate(); ?? public?void?SomeMethod() ?? {…} ?? SomeDelegate?someDelegate=SomeMethod; 总是把花括号“{”放在新的一行一个文件名应该能够反映它所对应的类名所有的类成员变量应该被声明在类的顶部，并用一个空行把它们和方法以及属性的声明区分开在最靠近一个局部变量被使用的地方声明该局部变量。1.?避免在同一个文件中放置多个类 .?避免在一个文件内写多于500行的代码（机器自动生成的代码除外） .?避免写超过行代码的方法 .?