NET程序编码规范.docVIP

NET程序编码规范(C#) 一、 命名规范 以下编码规范适用于C#开发。 以下命名规则如不特别说明一律采用Pascal命名方法，即首字母及每个单词首字大写。 Class(类),接口命名 名字应该能够标识事物的特性。 名字尽量不使用缩写，除非它是众所周知的。名字可以有两个或三个单词组成，但通常不应多于三个。例如 IsSuperUser，包含ID的，ID全部大写，如CustomerID。使用名词或名词短语命名类。少用缩写。例如：class MyButton{} class Dog{} 接口名称加前缀例如： Interface IAnimal{} 函数方法、委托、事件及属性命名 函数方法以动词或动词短语命名。无需区分函数和子程序，无返回值则为void。 private void clearText() 方法中如果是获取数据，则采用Get前缀，更新数据采用Update前缀。例如： public string GetConnection() //定义方法protected string UpdatePrivilege() private void clearText() 普通的委托类型以描述动作的名词命名，以体现委托类型实例的功能： 用于事件处理的委派类型，必须以EventHandler结尾，如：public delegate void InvateEventHandler(string InvitedName); 事件是特殊的属性，只能在事件处理上下文中使用。命名的原则一般是动词或动词的分词，通过时态表明事件发生的时间，可以加上后缀Event： 例如：public event InvateEventHandler InvateEvent 属性命名采用描述性名词或名词短语，属性必须对应于相关的私有字段 例如： //定义属性 private string name; public string Name { get { return name; } 　set { name = value;}} 常量、变量命名 变量命名延用匈牙利命名规则。Boolean b bFound Byte i iRasterData Short i iCount Int i iQuantity Long i iDistance float f fAverage Double dbl dblTolerance object obj objCurrent string str strName ArrayList arr arrValues DateTime dt dtLgoinDate 常量命名全部大写const int PAGE_SIZE = 20; ADO.NET 对象命名 Connection cnn cnnCommon Command cmd cmdUpdate DataReader dr drUser DataSet ds dsCustomer DataAdapet da daCommon 作用域命名 局部变量 按照变量命名规则, 不使用前缀模块级变量 m_dsCustomer 前缀m_系统全局变量 g_strConnection 前缀g_类的属性所对应的变量， m_strName前缀m_ 函数的参数 p_strSQL 前缀p_补充说明： 针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为e； 如果有冲突的情况下，可以重复e，比如：ee。Try { 　　 ……// your code 　　 try { 　　 // code } catch(Exception ee) { 　　 ……// your code } } catch(Exception e) { ……// your code } 补充：如果捕获异常不需要作任何处理，则不需要定义Exception实例例： try { ……// your code } catch( Exception ) { ……// your code } 二、 控件 以下为常用控件 控件 前缀 Label lbl TextBox txt CheckBox chk Button btn ListBox lst Calendar cal DataGrid dg DataList dl LinkButton lbn ListBox lbx Panel pnl RadioButton rad 三、 注释规范 函数的注释由于.NET提供了XML注释，推荐在函数方法前采用XML注释/// /// MyDataGrid 的摘要说明。 /// 采用XML注释后可以将注释直接导出成DOC文件。模