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.不要过度设计,在敏截中体会重构的乐趣
- C# 《编写高质量代码改善建议》整理&笔记 --(一)基本语言篇
- C# 《编写高质量代码改善建议》整理&笔记 --(四)资源管理&序列化
- C# 《编写高质量代码改善建议》整理&笔记 --(三)泛型&委托&事件
- 编写高质量代码改善C#程序的157个建议——建议9: 习惯重载运算符
- 编写高质量代码改善C#程序的157个建议——建议89:在并行方法体中谨慎使用锁
- 编写高质量代码改善C#程序的157个建议——建议92:谨慎将数组或集合作为属性
- 编写高质量代码改善C#程序的157个建议——建议107:区分静态类和单例
- 笔记:编写高质量代码 改善Java程序的151个建议
- 编写高质量代码改善C#程序的157个建议——建议119:不要使用自己的加密算法
- python编写高质量代码笔记—— 1.改善编码质量
- 《编写高质量代码 : 改善C#程序的157个建议》读书笔记 1-10
- 编写高质量代码改善C#程序的157个建议——建议144:一个方法只做一件事
- 编写高质量代码改善C#程序的157个建议[协变和逆变]
- 编写高质量代码改善C#程序的157个建议——建议21:选择正确的集合
- 编写高质量代码改善C#程序的157个建议——建议22:确保集合的线程安全
- 编写高质量代码改善C#程序的157个建议——建议34:为泛型参数设定约束
- 编写高质量代码改善C#程序的157个建议——建议38:小心闭包中的陷阱
- 编写高质量代码改善C#程序的157个建议[10-12]
- 编写高质量代码改善C#程序的157个建议——建议51:具有可释放字段的类型或拥有本机资源的类型应该是可释放的
- 编写高质量代码改善C#程序的157个建议——建议60:重新引发异常时使用Inner Exception