C#命名规则和编码规范

1、用Pascal规则来命名属性、方法、事件和类名

 public class HelloWorld
 {
     public void SayHello(string name)
     {
     }
 }

Pascal规则是指名称中单词的首字母大写 ,如EmployeeSalary、 ConfimationDialog、PlainTextEncoding。

2、用Camel规则来命名成员变量、局部变量和方法的参数

public class Product
 {
     private string productId;
     private string productName;

     public void AddProduct(string productId,string productName)
     {
     }
 }

Camel规则类似于Pascal规则 ,但名称中第一个单词的首字母不大写 ,如employeeSalary、 confimationDialog、plainTextEncoding。

3、不要使用匈牙利命名法。不要给成员变量加任何前缀（如、m、s_等等）。如果想要区分局部变量和成员变量，可以使用this关键字。

4、不要将常量或者只读变量的变量名全部大写，而使用Pascal规则来命名。

 // Correct
 public static const string ShippingType = "DropShip";

 // Avoid
 public static const string SHIPPINGTYPE = "DropShip";

5、接口的名称一般以大写I作前缀。

 public interface IConvertible
 {
     byte ToByte();
 }

6、自定义的属性以Attribute结尾。

public class TableAttribute:Attribute
 {
 }

7、自定义的异常以Exception结尾。

public class NullEmptyException:Exception
 {

 }

8、类的命名。用名词或名词短语来命名类名。

public class Employee
 {
 }
 public class BusinessLocation
 {
 }
 public class DocumentCollection
 {
 }

9、方法的命名。一般将其命名为动宾短语。

 public class File
 {
     public void CreateFile(string filePath)
     {
     }
     public void GetPath(string path)
     {
     }
 }

10、局部变量的名称要有意义。不要直接用用i,j,k,l,m,n,x,y,z等做变量名，但for循环除外。

11、一般C#的编码风格要求花括号{另起一行，不要直接跟在类名和方法后面。

public Sample(){
   // TODO: 在此处添加构造函数逻辑
}

12、判断条件是一个布尔变量时不要使用==进行条件判断。

// 不友好的写法private bool isFinished = true;if(isFinished == true)
{
    // ...
}
// 正确的写法private bool isFinished = true;if(isFinished)
{
    // ...
}