中证期货研究部软件开发命名规范(C#版).doc

中证期货研究部软件开发命名规范(C#版)本文档只适用于C#语言以及其实现的.NET Framework公共类型系统（CTS）第一部分 .NET C#编码规范简介一、使用编码规范的目标定义一些原则以保证编码格式的一致性，提高代码的可读性和可维护性，并保护开发人员尽量减少由编码引起的错误。二、术语和定义1.Camel命名法第一个单词的首字母小写，后续各单词的首字母均大写。例：depName2. Pascal命名法第一个单词首字母大写，后续个单词的首字母也大写。3 .公共类型系统.NET Framework公共类型系统(CTS)定义如何声明、使用和管理类型。所有本地的C#类型都基于CTS，支持跨语言集成。4.标识符自定义的标记，用于唯一命名对象或对象实例例：public class MyclassOfPersonal第二部分 命名相关（规范）一、通用规则1.始终使用Camel命名法或Pascal命名法。2.避免使用全部大写和全部小写的名称，单个小写单词或字母是允许的。3.不要创建只按照大写而改变的命名空间、类、方法、属性、字段或参数。4.不要使用以数字字符开头的名称。5.选择有意义且特定的名称。6.尽量使用详尽而不过于简洁的命名。7.变量和属性应该描述实体而不是类型或大小。8.不推荐使用匈牙利命名法。9.避免使用缩略语，除非全程过长。10.避免使用超过5个字符的缩略语。11.所有的缩略语都必须为大家所熟知和接受。12.对两个字母的缩略语使用小写，而对较长的缩略语使用Pascal命名法。13.不使用C#保留字作为名称。14.避免命名与现有.NET Framework命名空间或类型冲突。15.避免向标识符添加冗长或没有意义的前缀和后缀。16.不要在属性名称中包含父类名称。17.尽量将Can Is Has 用做布尔变量和属性的前缀。18.在适当的地方将计算限定符附加给变量名称，如Average、Count、Sum、Min、Max19.定义根命名空间时，请将产品名、公司名或开发人员姓名作为根。20. 类、接口、变量以及数据库表名、字段名等的命名都需要用有意义的英文单词命名，不能使用中文拼音，如XinYongKa这种方法，更不能使用中文拼音的缩写，如XYK。变量名中不要使用下划线“_”。21. 不要使用单个字符作为变量名，如使用单个字母的变量象i, n, t 等，而应使用index、number、temp等完整的有意义的单词。i变量只用于迭代计数（如for循环里的i），不能在循环迭代的其他地方出现。二、细化规则项目文件：Pascal命名法。始终将程序集名称与根命名空间匹配。源文件：Pascal命名法，始终将类名与文件名匹配。避免每个文件包括多个类、枚举（全局）或委托（全局）。包含多个类、枚举或委托时，使用描述性文件名。资源或嵌入式文件：尽量使用Pascal命名法。使用描述文件内容的名称。命名空间：Pascal命名法。尽量与醒目/程序集名称部分匹配。类或结构：Pascal命名法。用名词或名词短语作为类名称。如果可能，在为其他类型划分子类是添加相应的类后缀。接口：Pascal命名法。用大写字母I作为接口名称的前缀。方法：Pascal命名法。尽量使用动词或动词与对象组合。属性：Pascal命名法。属性名称应该表示其返回的实体。绝对不要将Get或Set用作属性名称的前缀。常量或静态字段：作为字段处理，选择以上相应的字段访问修饰符。常量名均为大写，字之间用下划线分隔枚举：使用Pascal命名法（类型和选项），枚举类型以复数结尾。如：enum Colors Red, Black, Blue委托或事件：作为字段处理，选择以上相应的字段访问修饰符。参数：Camel命名法。三、代码注释1、使用/或/，不使用/*.*/。2、不要使用行内注释解释明显易懂的代码，质量高的编码具有自解释性能。注释（Comment）规范注释规范包括：模块（类）注释规范、类的属性、方法注释规范、代码间注释(1)模块（类）注释规范模块开始必须以以下形式书写模块注释：/模块编号：/作用：/作者：作者中文名/编写日期：/如果模块有修改，则每次修改必须添加以下注释：/Log编号：/修改描述：/作者：修改者中文名/修改日期：/(2)类属性注释规范在类的属性必须以以下格式编写属性注释：/ /属性说明/ (3)方法注释规范在类的方法声明前必须以以下格式编写注释/ / 说明：/ / param name=/ / (4)代码间注释规范代码间注释分为单行注释和多行注释：单行注释：/多行注释：/*多行注释1多行注释2多行注释3*/代码中遇到语句块时必须添加注释（if,for,foreach,）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。第三部分 .NET C#编码规范编码风格（此部分推荐，非强制）编码风格：以下描述实现C#源代码推荐的方法，以便创建易于理解、易于维护、可读性强、结构清晰并且前后一致的代码。一、格式设置：1、每个文件不要声明多个命名空间。2、避免在单个文件中放置多个类。3、将大括号和放置于新行。4、在条件语句中使用大括号和。5、使用大小为4的制表符和缩进。6、独立声明每个变量，即不在同一个语句中声明多个变量。7、将命名空间和using语句置于文件顶部。将命名空间分组为.NET 命名空间和自定义命名空间。8、按照以下顺序按类型对内部类进行分组。成员变量。构造函数与析构函数。嵌套枚举、结构和类。属性。方法。9、根据访问修饰符和可见性为类型中的序列声明分组。PublicProtectedInternalPrivate10、将文件夹名称附加到子文件夹内源文件的命名空间。11、递归缩进括号内包含的所有代码块。12、使用空白（回车符/换行符、制表符等）分割和组织代码。13、将程序集