C# 《编写高质量代码改善建议》整理&笔记 --(六)编码规范及习惯

一.命名规范

1.考虑在命名空间中使用复数

　　System.AllCollections

　　System.TheCollection

2.用名词和名词组给类型命名

　　ScoreManager

　　UserController

3.用形容词给接口命名

　　接口的规范是“Can Do”，也就是说它规范的是类型可以具有哪些行为。所以接口的命名应该是一个形容词组，前面增加I.

　　IDisposable

　　IEnumerable

4.考虑让子类的名字以基类名字作为后缀

　　class MyException:Exception {}

5.用PascalCasing命名公开元素

　　开放给调用者的属性，字段，方法都应该采用PascalCasing命名方式。

6.用camelCasing命名私有字段和局部变量

　　private string firstName;

7.委托和事件类型应添加上级后缀

委托按照委托类型的作用分为以Delegate结尾和CallBack结尾。如果委托用于回调性质，则shiyongCallBack结尾。

8.事件和委托变量使用动词或形容词短语命名

public event RutedEventHandler Click;

public event SizeChangedEventHandler SizeChanged;

二.代码整洁

代码整洁的要求之一就是减少代码。

1.使用默认的访问修饰符

　　　既可以减少代码的数量，还有助于我们熟悉代码的默认行为。

2.不知道该不该用大括号的时，就用

　　如if语句下只有一行语句，要不要用大括号。一个括号不会增加多少代码，但是却让代码看上去增加了一致性。

3.只对外公布必要的操作

4.使用表驱动法来避免过长的if或switch分支

5.最少甚至不要注释

6.若抛出异常，则必须注释

三.规范开发行为

1.不要过度设计，在敏截中体会重构的乐趣

转载于:https://www.cnblogs.com/u3ddjw/p/10208302.html