C#开发规范

最近发现网上公布的IDesign C# Coding Standard 2.1很少有中文版，所以综合了之前基于vs2003版的编码规范，翻译了一下vs2005版的编码规范。其中有几章因为所涉及甚少，故翻译的不是很明白，请高手指教啦

以下是节选，全部内容请见附件。

 

一、         命名规则和风格 

1.      类和方法采用Pascal风格命名 。

    public class SomeClass

{

const int DefaultSize = 100;

public SomeMethod()

{}

}

2.      局部变量和方法参数采用Camel风格命名。

int number;

void MyMethod(int someNumber)

{}

3.      接口采用I作为前缀命名。

interface IMyInterface

{..}

4.      私有成员变量采用m_作为前缀命名，使用Pascal命名风格并在名称前面加上m_。

public class SomeClass

{

private int m_Number;

}

5.      自定义属性类型以Attribute作为后缀命名。

6.      自定义异常类型以Exception作为后缀命名。

7.      采用动词-宾语对命名方法，例如ShowDialog() 。

8.      有返回值的方法的命名应该能够描述其返回值，例如GetObjectState()。

9.      采用描述性的变量名。

    a) 避免采用单字母的变量名，如i或t；而是采用index或temp。

b) 对public和protected成员避免采用用匈牙利命名法。

c) 不要采用缩写（例如将number缩写为num）。

10. 总是使用C#预定义的类型，而不是使用System命名空间中的别名。

例如：采用object不用Object，

采用string不用String,

采用int不用Int32。

11. 对于泛型，类型采用大写字母。当处理.NET类型的Type时保留其后缀Type。

// 正确方法：

public class LinkedList<K,T>

{……}

// 避免使用：

    public class LinkedList<KeyType,DataType> 

{……}

12. 采用有意义的命名空间名，例如产品名称或公司名称。

13. 避免使用类的全称，而是采用using声明。

14. 避免在命名空间内使用using语句。

......................................