C#编程规范（常用版）

编程规范的目的

一个软件的生命周期中，80%的花费在于维护；

几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；

编码规范可以改善软件的可读性，可以让程序员尽快而彻底的理解新代码；

为了执行规范，每个软件开发人员必须一致遵守编码规范；

使用统一编码规范的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解程序代码；

好的编码规范可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。

干程序，我们是专业的！

 

命名规范

通常来讲，名称是以意思相近的英文描述而命名的；例如：一个打开连接的方法 => open connection => OpenConnection()；

到达 看其名，知其意 的效果；提高代码的可读性和理解性。

1. Pascal （大驼峰）命名方式

命名空间、类、接口、抽象类、结构体、枚举类、方法名、以及类中的属性，须要使用 Pascal 命名规范；名称中每一个单词的首字母都要大写；

例如：HttpClient、GetString() ；

在这里，本人还想分享一下我自己的编程习惯。

接口

官方文档中提到，接口的命名需要在其名称前加大写字母“I”，取自于 interface 关键字，例如：IDisposable、IDbConnection；

抽象类和枚举类

抽象类和枚举类是两种特殊的类，我们也可以在自定义的抽象类名称前加大写字母“A”，取自于 abstract 关键字，例如：ADataCollector 数据采集抽象类；

而对于枚举类，我们可以在自定义的枚举类名称前加大写字母“E”，取自于 enum 关键字，例如：ELogType 日志类型枚举类；

当然，这个只是我个人的小习惯，目的只有一个，更易于理解所写的代码；只要看到 A 开头的类名，就知道是自定义的抽象类，只要看到 E 开头的类名，就知道是自定义的枚举类。

（以上两点并不是必须的，根据个人意愿而为之）

实体类

实体类是非常常用的自定义类，类名最好用 “Entity” 结尾；例如：用户信息实体类 UserInfoEntity；好处也是易于理解，只要看到以 “Entity” 结尾的类名，就知道是一个实体类。

或者用 “Model” 结尾；例如：UserInfoModel 用户信息实体类。（ 不推荐，因为 “Model” 释义为“模型”，模型与实体类还是有很大区别的 ）

通用的工具类或帮助类

在实际开发中我们会自定义许多的通用类，以便提高开发效率，而这样的类，我们一般在其类名后面加上 “Tool”或“Utils”或“Helper” 结尾&