NET程序编码规范

《NET程序编码规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、NET程序编码规范(C#)一、命名规范以下编码规范适用于C#开发。以下命名规则如不特别说明一律采用Pascal命名方法，即首字母及每个单词首字大写。Class(类),接口命名²名字应该能够标识事物的特性。²名字尽量不使用缩写，除非它是众所周知的。²名字可以有两个或三个单词组成，但通常不应多于三个。²例如IsSuperUser，包含ID的，ID全部大写，如CustomerID。²使用名词或名词短语命名类。²少用缩写。例如：classMyButton{}classDog{}²接口名称加前缀例如：InterfaceIAnimal{}函数方法、委托、事件及属性命名²函数方法以动词或动词短语命名。无需

2、区分函数和子程序，无返回值则为void。²类内部私有函数函数名第一个字母不需要大写。如：privatevoidclearText()²方法中如果是获取数据，则采用Get前缀，更新数据采用Update前缀。例如：publicstringGetConnection()//定义方法protectedstringUpdatePrivilege()privatevoidclearText()²普通的委托类型以描述动作的名词命名，以体现委托类型实例的功能：用于事件处理的委派类型，必须以EventHandler结尾，如：publicdelegatevoidInvateEventHandler(string

3、InvitedName);事件是特殊的属性，只能在事件处理上下文中使用。命名的原则一般是动词或动词的分词，通过时态表明事件发生的时间，可以加上后缀Event：例如：publiceventInvateEventHandlerInvateEvent属性命名采用描述性名词或名词短语，属性必须对应于相关的私有字段例如：//定义属性privatestringname;publicstringName{get{returnname;}　set{name=value;}}常量、变量命名变量命名延用匈牙利命名规则。²变量定义示例：BooleanbbFoundByteiiRasterDataShortiiCo

4、untIntiiQuantityLongiiDistancefloatffAverageDoubledbldblToleranceobjectobjobjCurrentstringstrstrNameArrayListarrarrValuesDateTimedtdtLgoinDate²常量命名全部大写constintPAGE_SIZE=20;²ADO.NET对象命名对象定义示例：ConnectioncnncnnCommonCommandcmdcmdUpdateDataReaderdrdrUserDataSetdsdsCustomerDataAdapetdadaCommon²作用域命名局部变量

5、按照变量命名规则,不使用前缀模块级变量m_dsCustomer前缀m_系统全局变量g_strConnection前缀g_类的属性所对应的变量，m_strName前缀m_函数的参数p_strSQL前缀p_²补充说明：针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为e；如果有冲突的情况下，可以重复e，比如：ee。Try{　　……//yourcode　　try{　　//code}catch(Exceptionee){　　……//yourcode}}catch(Exceptione){……//yourcode}²补充：如果捕获异常不需要作任何处理，则不需要定义Excep

6、tion实例例：try{……//yourcode}catch(Exception){……//yourcode}二、控件以下为常用控件控件前缀LabellblTextBoxtxtCheckBoxchkButtonbtnListBoxlstCalendarcalDataGriddgDataListdlLinkButtonlbnListBoxlbxPanelpnlRadioButtonrad三、注释规范²函数的注释由于.NET提供了XML注释，推荐在函数方法前采用XML注释//////MyDataGrid的摘要说明。///采用XML注释后可以将注释直接导出成DOC文件。l模块开始必须以以下形式书写

7、模块注释：//////模块编号：///作用：///作者：作者中文名///编写日期：///l如果模块有修改，则每次修改必须添加以下注释：//////Log编号：///修改描述：///作者：修改者中文名///修改日期：///l在类的方法声明前必须以以下格式编写注释//////说明：//////"〉/////////l代码间注释分为单行注释和多行注释：单行注释：//多行注释：/*多行注释1　多行注释2　多行注释3*