NET开发编码规范

北京六智信息技术有限公司.Net开发编码规范V1.02007-6-12第3页共3页.NET开发编码规范一、目的为了完善公司的开发体系，保证企业编写出的程序都符合相同的规范，增加其可读性,减少错误的发生，并保证一致性、统一性而建立的程序编码规范。二、适用范围本规范适用公司开发的.NET项目。三、规范内容本规范包括：命名规范、代码格式规范、注释规范。四、命名规范（说明：Pascal大小写形式――所有单词第一个字母大写，其他字母小写。Camel大小写形式――除了第一个单词，所有单词第一个字母大写，其他字母小写。）1、类命名规范类名使用Pascal大小写形式，类名的命名规范必须以名词或名词短语命名，这样可以直观的体现类的功能。代码实例如下： classEmployees{ //编写代码}classHelloWorld{//编写代码}当类是一个特性（Attribute）时，以Attribute结尾。代码实例如下：classEmployeesAttribute{//编写代码}当类为一个事件处理的数据时，以EventArgs结尾。代码实例如下：classEmployeesNameChangedEventArgs{//编写代码}当类只用于作为其他类的基类，根据情况，以Base结尾：classabstractEmployeesBase{//编写代码}当类是一个窗体，那么名字的后面必须加后缀Form，如果是Web窗体，必须加后缀Page：classPrintForm:Form//Windows窗体{//编写代码}classStartPage:Page//Web窗体{//编写代码}2、结构命名规范结构名称前必须加入stc。后面的名称应该能够体现枚举和结构的特征。代码实例如下：structstcMessage{//编写代码}2、枚举和结构命名规范枚举名称前必须加入enu。后面的名称应该能够体现枚举和结构的特征。代码实例如下：enumenuMessageType{//编写代码}3、委托类型命名规范委托名称前必须加入deg。1、普通委托命名规范普通委托命名规范以描述动作的名词为命名，以体现委托的功能。代码实例如下：delegatevoiddegMployeeRulesChanged(StringRules);2、事件的委托命名规范事件的委托命名规范也是以描述动作的名词命名，但应在名称的后面加上EventHandler字符。体现这是一个事件的委托。代码实例如下：delegatevoiddegColoreChangedEventHandler(objectsender,EventArgse);4、接口类型的命名规范接口类型的定义和类类型的定义一样。但是必须在名称前边加上大写的“I”字符，表示这是一个接口。代码实例如下：interfaceICollection{//编写代码}5、方法、函数命名规范方法使用Pascal大小写形式，方法的名称必须以动词或者动词短语构成。体现她的功能。方法的首字母必须大写。方法名称中不允许有下划线(“_”)。方法必须交限定符，如：public、private、internal、protected等。代码实例如下：publicvoidSayHello(){//编写代码}6、属性的命名规范由于类中的成员变量无法访问，因此提供了