中证期货研究部软件开发命名规范[C#版].docVIP

中证期货研究部软件开发命名规范(C#版) 本文档只适用于C#语言以及其实现的.NET Framework公共类型系统（CTS）第一部分 .NET C#编码规范—简介一、使用编码规范的目标定义一些原则以保证编码格式的一致性，提高代码的可读性和可维护性，并保护开发人员尽量减少由编码引起的错误。二、术语和定义.Camel命名法第一个单词的首字母小写，后续各单词的首字母均大写。例：depName. Pascal命名法第一个单词首字母大写，后续个单词的首字母也大写。.公共类型系统.NET Framework公共类型系统(CTS)定义如何声明、使用和管理类型。所有本地的C#类型都基于CTS，支持跨语言集成。.标识符自定义的标记，用于唯一命名对象或对象实例例：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、MinMax 19.定义根命名空间时，请将产品名、公司名或开发人员姓名作为根。使用单个字母的变量象i, n, 等使用indextemp等变量只用于迭代计数在循环迭代的其他地方出现二、项目文件：Pascal命名法。始终将程序集名称与根命名空间匹配。源文件：Pascal命名法，始终将类名与文件名匹配。避免每个文件包括多个类、枚举（全局）或委托（全局）。包含多个类、枚举或委托时，使用描述性文件名。资源或嵌入式文件：尽量使用Pascal命名法。使用描述文件内容的名称。命名空间：Pascal命名法。尽量与醒目/程序集名称部分匹配。类或结构：Pascal命名法。用名词或名词短语作为类名称。如果可能，在为其他类型划分子类是添加相应的类后缀。接口：Pascal命名法。用大写字母I作为接口名称的前缀。方法：Pascal命名法。尽量使用动词或动词与对象组合。属性：Pascal命名法。属性名称应该表示其返回的实体。绝对不要将Get或Set用作属性名称的前缀。常量或静态字段：作为字段处理，选择以上相应的字段访问修饰符。枚举：使用Pascal命名法（类型和选项）enum Colors{ Red, Black, Blue} 委托或事件：作为字段处理，选择以上相应的字段访问修饰符。参数：Camel命名法。、代码注释1、使用//或///，不使用/*….*/。、不要使用行内注释解释明显易懂的代码，质量高的编码具有自解释性能。Comment）规范 注释规范包括：模块（类）注释规范、类的属性、方法注释规范、代码间注释 (1)模块（类）注释规范 模块开始必须以以下形式书写模块注释： ///summary ///模块编号：模块编号，可以引用系统设计中的模块编号 ///作用：对此类的描述，可以引用系统设计中的描述 ///作者：作者中文名 ///编写日期：模块创建日期，格式：YYYY-MM-DD ////summary 如果模块有修改，则每次修改必须添加以下注释： ///summary ///Log编号：Log编号,从1开始一次增加 ///修改描述：对此修改的描述 ///作者：修改者中文名 ///修改日期：模块修改日期，格式：YYYY-MM-DD ////summary (2)类属性注释规范 在类的属性必须以以下格式编写属性注释： /// summary ///属性说明 /// /summary (3)方法注释规范 在类的方法声明前必须以以下格式编写注释 /// summary /// 说明：对该方法的说明 /// /summary /// param name=参数名称参数说明/param /// returns ///对方法返回值的说明，该说明必须明确说明返回的值代表什么含义 /// /returns (4)代码间注释规范 代码间注释分为单行注释和多行注释： 单行注释： //