C#编码标准介绍
C#编码标准介绍
命名约定和风格1．使用Pascal的命名规范命名类型和方法的名字。
public class SomeClass
{
public SomeMethod(){}
}
2．使用camel命名规范命名局部变量和方法的参数。
int number;
void MyMethod(int someNumber)
{}
3．在命名接口的时候使用I作为前缀。
interface IMyInterface
{...}
4．私有成员变量使用m_作为前缀。
public class SomeClass
{
private int m_Number;
}
5．自定义的属性类使用Attribute作为其后缀。
6．自定义的异常类使用Exception作为其后缀。
7．在命名方法的时候使用动宾结构的短语，比如：ShowDialog()。
8．有返回值的方法应该有一个可以描述其返回值的名字，比如：GetObjectState()。
9．使用有意义的变量名称。
10．使用C#的预定义的类型而不使用System命名空间中其别名来申明变量。
使用object 而不是 Object
使用string 而不是 String
使用 int 而不是 Int32
11．通常情况下，类型使用大写字母。当处理.NET的类型的时候使用Type作为其后缀。
//正确的是：
public class LinkedList<K,T>
{…}
//避免使用：
public class LinkedList<KeyType,DataType>
{…}
12．使用有意义的命名空间，比如使用公司的名称以及产品的名称。
13．避免使用完全限定名。而使用using语句替换之。
14．避免将using语句写在命名空间的内部。
15．将所有的框架定义的命名空间为一组，自定义的和第三方的命名空间放在另一组。
using System;
using System.Collections.
using System.ComponentModel;
using System.Data;
using MyCompany.
using MyControls;
16．使用委托的引用替换显式的委托实例。
delegate void SomeDelegate();
public void SomeMethod()
{…}
SomeDelegate someDelegate = SomeMethod;
17．保持严格的缩进风格。
a.使用3个空格缩进
b.不要使用tabs或者其他不标准的缩进，比如1、2、4个空格。
18．在编写注释的时候注释的缩进和编码的缩进必须是相同级别的。
19．所有的注释都要通过拼写检查，错误的拼写是粗糙的开发。（针对汉语则要语句通顺易于理解）
20．所有的成员变量都应该声明在顶部，同时使用一个空行来将他们和属性以及方法分开。
public class MyClass
{
int m_Number;
string m_Name;
public void SomeMethod1()
{}
public void SomeMethod2()
{}
}
21．尽可能在第一次使用局部变量的时候申明它。
22．文件名称应该可以反映出它所包含的类。
23．当使用不完整的类并且将部分分配到每个文件中，用P+序数作为后缀命名文件。
// in myClassP1.cs
public partial class MyClass
{…}
// in myClassP2.cs
public partial class MyClass
{…}
24．总是将大括号放在一个新行上。
25．匿名方法和一般（正规）的方法代码使用相似的代码布局
a.规定：大括号（方法体的括号）必须使用新行
delegate void SomeDelegate(string someString);
// 正确的是：
public void InvokeMethod()
{
SomeDelegate someDelegate = delegate(string name)
{
MessageBox.Show(name);
};
someDelegate(“Juval”);
}
// 避免使用：
public void InvokeMethod()
{
SomeDelegate someDelegate = delegate(string name){ MessageBox.Show(name);};
someDelegate(“Juval”);
}
26．在匿名无参方法中要使用空的括号。
a.如果匿名方法有可能被使用在任何委托中那么可以省略括号。
delegate void SomeDelegate();
// 正确的方法是：
SomeDelegate someDelegate1 = delegate()
{
MessageBox.Show(“Hello”);
}
// 避免使用：
SomeDelegate someDelegate1 = delegate
{
MessageBox.Show(“Hello”);
}