聊聊.net 程序设计——命名规范（下）

 

前两天因为写了Visual Studio 2010中的建模拓展工具的使用《聊聊.net程序设计——浅谈使用VS2010建模拓展（上）》《聊聊.net程序设计——浅谈使用VS2010建模拓展（下）》2篇文章，所以将该系列暂时放下了，现在我想接着《聊聊.net程序设计——命名规范（上）》写后半部分。对于命名规范大家都不陌生一直都在工作或者学习中使用，我在这里只是阐述的我的一些看法，我个人认为之所以叫规范一定是一群人设定的一些限制条目。但我认为在团队或者公司级别研发中往往最适合我们自己的才是最好的。别人设定的条目我们可以参照但没必要完全拷贝，因为适合他人不一定适合自己。

好了，我们接着上部分往下说，现在我们来聊聊具体的命名规范。

一、程序集和动态链接库（DLL）的命名

程序集是一个部署单元，一般来说一个程序集仅与一个DLL对应。命名空间和DLL和程序集不是一个概念，命名空间一般来说是一个逻辑实体而DLL和程序集是用于打包和部署的一个单元，一个DLL可以包含多个命名空间，一般将DLL命名为System.Net 不一定命名空间也为System.Net。

首先、要为程序集或者DLL选择具有代表性的名字命名，比如：System.Net，一眼就能看出它的大致用途。这样的命名才是最合适的，才具有实际的意义。如果我们的命名不能很好的表达它具体的功能那么就需要重新考虑更改命名了，因为不能很好表达出具体功能的命名我认为就是失败的不合适的，因为这样的命名并没有给你带来任何好处反而让程序变得很混乱不之所云。

其次、推荐一种命名结构，即使用“公司名称/机构名称”+“.”+“组件名称”+”.”+”dll”的方式来命名。因为这样会使结构更清晰。

二、命名空间的命名

首先、命名空间要采用PascalCasing大小写风格，各部分用“.”隔开。

其次、要尽量使用“公司名称”为前缀，然后加组件描述名称，因为这样不会与其他第三方命名相冲突。

三、接口的命名

接口在实际工作中是我们经常接触到的，它是一种约束一种抽象，对于它的命名一般采用微软的命名习惯即：“I”+具体功能的描述。这种命名已经被大多数开发人员接受，一看见以大写I开头一般都会认为是接口。需要注意的是I后面的命名采用PascalCasing大小写风格并采用形容词有时也可以是名词来命名，如：ICollection。

四、类和结构的命名

类和结构一般采用PascalCasing大小写风格，采用名词或名词短语来命名。

不要为类名加前缀，比如“C”。

考虑在派生类结尾采用基类名称。

五、枚举类型的命名

这个也是目前我们公司争议最大的地方，有些人认为加“Enum”前缀或者后缀会更好一些，这样一眼就能确定它是枚举类型，还有一部分人认为应该墨守微软的陈规不应该加”Enum”的前缀或者后缀。公所公有理，婆说婆有理，最终我们目前采用的是“Enum”前缀命名方式。（少数服从多数吧）

枚举采用PascalCasing大小写风格。

六、方法的命名

采用PascalCasing大小写风格。

采用动词或者动词短语来命名方法。

七、属性的命名

采用PascalCasing大小写风格。

采用名称或者形容词来命名属性。

要采用项目短语的复数形式来命名集合属性。

要有肯定性的短语来命名布尔属性如：CanRead。

八、事件的命名

要采用PascalCasing大小写风格。

要采用动词或者动词短语的时态来表示事件发生时间。

要在处理函数加“EventHandler”后缀。

要在事件处理函数中采用“sender”“e”作为两个参数的名字。

要在命名时间参数时加“EventArgs”后缀。

九、字段的命名

采用Pasca大小写风格。

用名词、名称短语或者形容词来命名字段。

不要为字段加前缀。

十、参数的命名

采用camelCasing大小写风格。

要使用具有描述性的参数名称。

以上是对开发时常用的一些命名规则的描述，希望对大家有帮助！

本文参考文献《.NET 设计规范约定、惯用法与模式（第2版）》