浅析.NET开发过程中命名的数量和人称

作者:控件中国网   出处:控件中国网   2015-07-22 11:18:00   阅读:3

今天们将介绍的是.NET开发过程中命名的数量和人称,们都知道命名的重要性,特别的情况是动词的人称和名词的数量。


 

AD: eDocEngine VCL - PDF控件 —正版、购买、下载、价格、销售、代理、授权、技术支持尽在控件中国网

 

 

们都明白命名的重要性,如果对命名不断地关注,就需要考虑命名中的动词和名词,特别的情况是动词的人称和名词的数量。


 

在.NET Framework的Guideline中,有专门一章讨论了命名规范,包括大小写、单词的选择等,却没有涉及到人称和数量,下面来讨论一下这两方面的内容。


 

名词的数量


 

首先来看数量。名词的单数和复数在语义上有着明显的不同,为了提高可读性,数量需要认真地考虑。比如:


 

属性(Property):System.Collections.Generic.Dictionary TKey, TValue 中的Keys和Count是好的例子。字段与此类似; 方法名中的名词:在JS中们熟悉的getElementById和getElementsByTagName;


 

局部变量:与属性相比,们更可能遭遇的是局部变量。比如,用变量来表示一个人的名字,可以用string name; 如果是多个人的名字,则可以用List string names。


 

一般地,单数表达的语义是?(0或1);复数表达的语义是*(0、1或多个)。关于名词的数量很容易理解,相关的规则也容易遵循。


 

动词的人称


 

下面再来考虑动词的人称。在需要考虑命名的对象中,包括命名空间、类型、各种类型成员,只有方法是动词,语义上表示一个行为。关于它的人称,来看一个.NET Framework中的例子。在System.Collections.Generic.Stack T 中,有一个Contains(T item)方法,对于这样的代码:


 

if (theStack.Contains(1))   {   // Do something.   } 


 

读起来像是:if the stack contains 1,比较通顺。是不是所有方法都要这样命名呢?没有。另两个方法Clear()和Push(T item)就不是如此,这个地方很让人困惑。先写成代码看看


 

theStack.Push(3);   theStack.Clear(); 


 

尝试像上面那样作为一个句子来读:the stack push 3; the stack clear,语法上不对,看起来也应该是第三人称。这里也不确定为何如此,只能尝试来解释下。考察多个集合类型和其它类型后发现,所有使用第三人称的地方都是谓词函数,除了上面的Contains(T item),还有Directory.Exists(string path),不知道这是不是其中的命名规则呢?


 

还要考虑注释


 

一定程度上,注释也算是一种代码。一种是XML文档注释,在.NET Framework中,不管是对于类型还是类型成员,都使用了第三人称,这一点们也可以遵循。其它的普通注释应该也可以遵循这个规则。


 

eDocEngine VCL - PDF控件 —正版、购买、下载、价格、销售、代理、授权、技术支持尽在控件中国网

 

Copyright© 2006-2015 ComponentCN.com all rights reserved.重庆磐岩科技有限公司(控件中国网) 版权所有 渝ICP备12000264号 法律顾问:元炳律师事务所
客服软件
live chat