C# | .NET命名规范

.NET命名规范

前言

“软件工程不是一个人完成的。”
在软件开发中我们的工作几乎不会是独立存在的，所以和身边其他合作者代码风格的统一是一件事关团队开发效率的事。

我有过用不同的语言和在不同的框架下做开发的经验，发现不同的语言在不同的框架下其代码风格都会有很大差异。然而现在正在使用的.NET（C#）是一个正在迈向统一的平台，因此使用C#的工程师会有更多尝试其他框架的机会，因此有时读网上的代码甚至是同事的代码时不免扶额直呼头大。

由于我们使用的C#语言和.NET平台皆是来自Microsoft的产品，因此也建议C#开发者的命名规范尽量向微软提供的规范看齐，毕竟调用API和使用VS快捷键产生代码的时候不至于产生违和感。

基本规范

1. 不要使用拼音；
2. 不要使用生僻的单词；
3. 要做到见名知意，含义清晰最重要，其次才是简洁；
4. 若非单词的特定缩写，不要在多单词组合的命名中使用缩写；
5. 若非广泛认可的首字母缩写词（如：IO），尽量避免使用在命名中；

大小写

私有变量、参数名称可使用Camel命名规范（也叫驼峰命名法）。
方法、属性、类、事件、委托等一些列主要用于公共访问的元素，请使用Pascal命名规范（也叫双峰命名法）。
Pascal命名规范须遵循以下两点：

1. 单词的首字母大写；
2. 不要使用下划线；

命名空间

与其他命名准则一样，命名命名空间旨在让使用框架的程序员获得足够的信息，使其立即知道命名空间的内容可能是什么。 以下模板指定命名命名空间的一般规则：

组织名.产品名(或功能名、技术名).[子命名空间]

1. 命名空间的第一层应依据项目性质写为企业名称、组织名、个人名；
2. 请勿将部门名称置于命名空间第二层（因为部门可能会变更，项目与部门之间的关系并不一定绝对绑定[doge]）；
3. 虽然命名空间建议使用Pascal命名规范，但如果企业名或项目名本身注册或公开的命名并不符合这一规范，应使用原本的命名；
4. 避免命名空间和常见类型名称重名；
5. 命名空间可以使用负数以避免与内部的主要类型重名；

类、结构和接口

在命名类型和结构时：

1. 使用Pascal命名规范；
2. 使用名词或名词短语命名；
3. 请勿添加前缀（如：C++中在类名前加’C’）；

在命名接口时：

1. 建议使用形容词短语（如：IDisposal）；
2. 请务必在接口名称前加上字母‘I’，表示该类型是一个接口；