第二章 编码惯例

 

1.         避免在一个文件中放多个类。

2.         一个文件应该只对一个命名空间提供类型。避免在同一文件中有多个命名空间。

3.         避免文件长度超过500行(除了机器自动产生的代码)。

4.         避免方法定义超过25行。

5.         避免超过5个参数的方法。使用结构传递多个参数。

6.         每行应该不超过80个字符。

7.         不要手工编辑任何机器生成的代码。

8.         避免对显而易见的内容作注释。

9.         仅对操作的前提、内在算法等写文档。

10.     决不要硬编码数值， 而总是声明一个常量。

11.     仅对本来就是常量的值使用const修饰符，例如一周的天数。

12.     避免对只读变量使用const修饰符。在此情况下，采用readonly修饰符。

public class MyClass

{

public readonly int Number;

public MyClass(int someValue)

{

Number = someValue;

}

public const int DaysInWeek = 7;

}

13.     避免采用friend程序集，因为这样增加了程序集间的耦合度。（声明上下文中的所有代码均可以访问其元素）

14.     if语句总是使用括号，即使它包含一句语句。

15.     避免使用?:条件算符。

16.     避免在布尔条件语句中调用函数。赋值到局部变量并检查它们的值。

17.     总是使用从0开始的数组。

18.     总是使用一个for循环显式地初始化一个引用类型的数组。

public class MyClass

{}

MyClass[] array = new MyClass[100];

for(int index = 0; index < array.Length; index++)

{

array[index] = new MyClass();

}

19.     避免使用new继承修饰符，而是使用override。

20.     除非涉及到互操作，永远不要用不安全的代码。

21.     避免显式类型转换。使用as算法防护性地转换类型。

Dog dog = new GermanShepherd();

GermanShepherd shepherd = dog as GermanShepherd;

if(shepherd != null)

{...}

22.     总是使用接口。

23.     类和接口中方法和属性的比例至少是2：1。

24.     努力使每个接口拥有3-5个成员。

25.     避免将事件作为接口成员。

26.     优先使用明确的接口实现。

27.     将呈现给用户的字符串永远不用硬编码，而是使用资源

28.     发布时可能修改的字符串永远不用硬编码

29.     构建一个长字符串时，使用StringBuilder，不要用string。

30.     当提供静态成员变量时，总是提供一个静态构造函数

31.     只要可以用前期绑定就不要用后期绑定。

32.     对应用程序进行日志和跟踪。

33.     除非在switch语句中跳转，永远不要用goto语句。

34.     除非为了解决调用基类构造函数时成员名的冲突，否则不要使用base访问基类的成员

35.     使用泛型的代码中避免与System.Object进行类型转换