命名规范:
1、利用 Pascal 的方式定义类型、方法名和常量:
public class SomeClass
{
const int DefaultSize = 100;
public void SomeMethod() { }
}
2、对于局部变量和方法的参数使用骆驼命名法:
void MyMethod(int someNumber)
{
int number;
}
3、在私有成员变量前面加上m_。对于m_后面的变量名失业骆驼命名法:
public class SomeClass
{
private int m_Number;
}
4、对自定义的属性类加上后缀Attribute。
5、对自定义的异常类加上后缀Exception。
6、方法的命名是用动词+对象,例如:ShowDialog()。
7、有返回值的方法的命名中要有对返回值的描述,例如:GetObjectState()。
8、使用带有说明性的变量名:
a、避免单字符的变量名,例如 i 或 t 等,使用类似于 index 或 temp 这样有意义的名字。
b、对于 public 或 protected 类型的变量避免使用匈牙利表示法。
c、不要缩写单词,例如用 num 取代 number。
9、总是使用C#预定义的类型而不要使用在System名称空间中的别名,例如;
使用object而不是Object;
使用string而不是String;
使用int而不是Int32;
10、在使用泛型的时候,类型的首字母要大写。当处理.NET中的Type类型的时候,保留Type后缀。
public class LinkedList<K, T> { }
11、在和你的代码缩进处于同一级别处为该行代码添加注释。
12、所有的类成员变量应该被声明在类的顶部,并用一个空行把他们和方法以及属性的声明区分开。
13、在最靠近一个局部变量被使用的地方声明该局部变量。
14、一个文件名应该能够反映它所对应的类名。
15、当使用一个部分类并把该类分布到不同的文件中时,在每一个文件名末尾都加上该文件实现的部分在整体中扮演的作用,例如:
//In MyClass.cs
public partial class MyClass { }
//In MyClass.Designer.cs
public partial class MyClass { }
16、总是要把花括号“{”放在新的一行。