命名规范是我们在写代码之前首先要确定好的。本文是在IDesign(www.idesign.net)在网上流传的一份文档(C# coding standard version 2.1)的基础上完成的。

    使用命名规范的好处:

    在代码大全II中,作者阐述了许多条命名规范带来的好处:

l         要求你更多地按规矩行事。通过做一项全局决策而不是做许多局部决策,你可以集中精力关注代码更重要的特征。

l         有助于在项目之间传递知识。名字的相似性能让你理容易、更自信地理解那些不熟悉的变量原本应该做什么的。

l         有助于你在新项目中更快地学习代码。你无须了解其他组员代码中是什么样的规范,而只须面对一组更加一致的代码。

l         有助于减少名字增生。在没有命名规则的情况下,会很容易给同一个对象起两个不同的名字。这会让阅读这段代码的人感到困惑。

l         弥补编程语言的不足之处。

l         强调相关变量之间的关系。

       关键在于,采用任何一项规则都要好于没有规则。规则的存在为你的代码增加了结构,减少了你需要考虑的事情。

       命名规范:

1.         使用Pascal命名类和方法。枚举类型以复数结尾。

public class CreditCard
{
  
public string GetCardName()
}

2.         使用Camel来命名局部变量和方法参数。其名字应该与底层数据类型无关,而且应该反映该变量所代表的事物。

int cardCount;
public string GetCardName(string cardType)
{ }

3.        
接口前加前辍 I
interface IService{}  

4.         私有成员变量加前辍m_. 名字的其他部分使用Pascal命名方法。

public class CreditCard
{
    
private string m_CardName;
}


5.         自定义属性加后辍Attribute
6.         自定义异常加后辍Exception

7.         方法以动宾短语命名。例如ShowDialog( )

8.         有返回值的方法名中应该有返回值的描述。

9.         使用有意义的变量名。

l         不要使用单个字符作为变量名

l         不要使用匈牙利命名public 或者 protected 成员

l         不要缩写单词

10.     使用有意义的命名空间,如产品名,公司名。

Posted on 2006-09-26 11:38  GerryJiang  阅读(1169)  评论(0编辑  收藏  举报