接口命名原则.DOC

目 录 一、基础编程规范 3 1. 命名原则 3 1.1 大小写原则 3 1.2 命名规范 3 1.3 类的命名原则 3 1.4 接口命名原则 4 1.5 Exception命名原则 4 1.6 参数的命名 4 1.7 变量的命名 4 1.8 方法命名原则 5 1.9 属性命名原则 5 1.10 大小写敏感 5 2. 注释 5 2.1 注释通用原则 5 2.2 类和接口的注释 6 2.3 类成员变量的注释 6 2.4 方法的注释 6 2.5 程序中的注释 7 3. 其他通用规范 7 3.1 关于修改历史 7 3.2 成对出现的关键字和”{}”的使用 7 3.3 规则缩进 7 3.4 判断和循环的注释 7 3.5 缩写 7 3.6 关于汉语拼音 8 3.7 关于神秘的数字 8 基础编程规范 使用.net进行开发的过程中遵循的基本规范。 命名原则 编码中的命名规范和原则 大小写原则 目前存在不同的大小写规范，下面列出的这些规范将在其后的章节反复引用。 Pascal Casing 每个单词的第一个字母大写，例如：BackColor Camel Casing 除了第一个单词以外的每个单词的第一个字母大写，例如：backColor Upper case 如果缩写字母的个数小于或等于2，那么所有的缩写字母都大写。3个以上的字母缩写采用Pascal Casing。例如：System.IO, System.Web.UI, System.CodeDom。 命名规范 类型 命名规范 备注 Class PascalCase ? Enum values PascalCase ? Enum type PascalCase ? Events PascalCase ? Exception class PascalCase 以 Exception结尾 Final Static field PascalCase ? interface PascalCase 用大写字母 I开头 Method PascalCase ? Namespace PascalCase ? property PascalCase ? Public Instance Field PascalCase 很少使用, 用在properties Protected Instances Fields camelCase 很少使用, 用在properties parameter camelCase ? Public class FileStream ｛ ｝ Public class Button ｛ ｝ Public class String ｛ ｝ 接口命名原则 接口名字用名词或者名词短语，或形容词来表述接口的行为。 例如：IComponent (描述性名词)、ICustomAttributeProvider (名词短语)、IPersistable (形容词)等。 用Pascal 命名规则 尽量谨慎地使用缩写 不要用下划线作类名 接口名称前缀用字母I 有的时候, 必须用字母I作为类名前缀，而又不是一个接口。这是可以接受的，因为有的类名就是I开头的，例如： IdentityStore。这种情况和接口的区别在于其第二个字母是小写的。 有的时候，定义完一个接口之后，也会定义一个类作为接口的标准实现。该类和该接口应该有类似的名字，唯一的区别就是接口名称前缀为字母I。 下面的例子描述了接口 IComponent 和它的标准实现- 类 Component Public interface IComponent ｛ ｝ Public class Component ：IComponent ｛ ｝ Exception命名原则 异常的命名以“Exception”为后缀，且继承自平台提供的异常基类PlatformBaseException，例如： Public class UserAlreadyExistsException : PlatformBaseException ｛ ｝ 参数的命名 参数的名字应该是描述性的 参数的名字应该具有自描述性，也就是说参数的名称可以描述参数在大多数情况下的含义，参数的类型也是可以从参数的名字推断出来的。 参数的名字使用camel Casing（首字母小写） 参数的名字是基于参数的含义而不是参数的类型 不要使用保留参数（Win32 API常见） 如果下一个版本需要更多的参数，那么加一个overload的方法。 参数的命名示例如下： Type GetType(string typeName) String Format(string format, object[] args) 变量的命名 避免无意义的变量命名，如下的命名应该避免： Contract