C# 编写代码的命名规则

 

Pascal 规则

每个单词开头的字母大写(如 TestCounter).

Camel 规则

除了第一个单词外的其他单词的开头字母大写. 如. testCounter.

Upper 规则

仅用于一两个字符长的常量的缩写命名,超过三个字符长度应该应用Pascal规则.

例如：

public class Math

{

public const PI = ...

public const E = ...

public const FeigenBaumNumber = ...

}

 

具体的规则总结如下：

 

类命名指导

- 类名应该为名词及名词短语，尽可能使用完整的词.

- 使用Pascal规则

- 不要使用类前缀 - 不要使用下划线字符 (_)。

- 有时候需要提供以字母 I 开始的类名称，虽然该类不是接口。只要 I 是作为类名称组成部分的整个单词的第一个字母，这便是适当的。例如，类名称 IdentityStore 就是适当的。

- 在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，原因是 ApplicationException 是一种 Exception。请在应用该规则时进行合理的判断。例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，但是将 Control 作为类名称的一部分将使名称不必要地加长。

 

接口命名规则

- 接口名称应该为名词及名词短语或者描述其行为的形容词，尽可能使用完整的词. (Example IComponent or IEnumberable)

- 使用Pascal规则

- 使用字符I为前缀，并紧跟一个大写字母（即接口名的第一个字母大写）

例如：

interface ICompare
{
int Compare();
}

 

枚举命名规则

- 对于 Enum 类型和值名称使用 Pascal 大小写。

- 少用缩写。

- 不要在 Enum 类型名称上使用 Enum 后缀。

- 对大多数 Enum 类型使用单数名称，但是对作为位域的 Enum 类型使用复数名称。

- 总是将 FlagsAttribute 添加到位域 Enum 类型。

 

 变量命名

- 在简单的循环语句中计数器变量使用 i, j, k, l, m, n

- 使用 Camel 命名规则

 

方法命名

- 使用Pascal规则

- 对方法名采用一致的动词/宾语或宾语/动词顺序。例如，将动词置于前面时，所使用的名称诸如 InsertWidget 和 InsertSprocket；将宾语置于前面时，所使用的名称诸如 WidgetInsert 和 SprocketInsert。

- 推荐名称应该为动词或动词短语.例如Save，SaveCustomer，而不要使用CustomerSave

- 不要在方法中重复类的名称。例如，如果某个类已命名为 Book，则不要将某个方法称为 Book.CloseBook，而可以将方法命名为 Book.Close。

 

属性命名

- 名称应该为名词及名词短语

- 使用Pascal规则

- 对于bool型属性或者变量使用Is（is）作为前缀，不要使用Flag后缀，例如应该使用IsDeleted,而不要使用DeleteFlag

 

集合命名

- 名称应该为名词及名词短语

- 使用Pascal规则

- 名称后面追加“Collection”

 

事件命名

1. 代码的缩进。要用Tab，而不要用space.
2. 局部变量的名称要有意义。不要用x，y，z等等（除用于For循环变量中可使用i，j，k，l，m，n）。
3. 所有的成员变量声明在类的顶端，用一个换行把它和方法分开。
4. 用有意义的名字命名namespace，如：产品名、公司名。
5. 始终使用"{ }"包含if下的语句，即使只有一条语句。
6. 把相似的内容放在一起，比如数据成员、属性、方法、事件等，并适当的使用#region…#endregion。