七月 14

Visual Studio C#开发命名规范整理

当我们使用Visual Studio进行C#编程时,需要了解C#开发的命名规范。虽然就是不按照这些命名规范写出来的代码也可以执行,但是代码的可读性和可维护性将大大降低。另外大多数代码是多人协作写成的,按照C#命名规范来写也可以方便团队协作。这片文章是根据网上前人分享的经验进一步整理得到的,希望能够对新手朋友们有所帮助。

a) 类的命名

【规则1-1】类的命名使用Pascal规则,即每个单词的首字母都要大写。


Class TestClass
{
...
}

【规则1-2】使用能够反映类功能的名词或名词短语命名类。

【规则1-3】不要使用“I”、“C”、“_”等特定含义前缀。

【规则1-4】自定义异常类应以Exception结尾。


Class TestException
{
...
}

b) 类字段(即类成员变量)

【规则2-1】类字段的命名使用camel规则,即第一个单词首字母小写,后面其他单词的首字母大写。

【规则2-2】类字段变量名前可加“_”前缀,一般加“_”的成员变量为私有变量。

【规则2-3】坚决禁止在普通变量前加“m_”(这是VC老命名规则)。

Class TestClass
{
public string myName;
private string _myCoCo;
}

c)方法

【规则3-1】方法的命名使用Pascal规则,即每个单词的首字母都要大写。

【规则3-2】方法名应使用动词或动词短语。

【规则3-3】类中访问修饰符或功能相同的方法应该放在一起, 且公共或实现接口的方法在前。

Class TestClass
{
public void GetData(...)
{
...
}
}

d)属性

【规则4-1】属性的命名使用Pascal规则,即每个单词的首字母都要大写。

【规则4-2】属性和相应字段名称要关联, 可以使用“重构”菜单来生成属性。

Class TestClass
{
private string myName;
public string MyName
{
set { myName = Value; }
get { return myName; }
}
}

e)参数

【规则5-1】参数的命名使用camel规则,即第一个单词首字母小写,后面其他单词的首字母大写。

【规则5-2】使用描述性参数名称,参数名称应当具有最够的说明性。

【规则5-3】不要给参数加匈牙利语类型表示法的前缀。

【规则5-4】检查方法所有输入参数的有效性。

Class TestClass
{
public void GetData(string name,string strFlag)
{
...
}
}

f)常量

【规则6-1】只读常量和静态的字段或属性的命名使用Pascal规则,即每个单词的首字母都要大写。

【规则6-2】枚举名使用Pascal规则命名,枚举成员本质属于常量,命名规则同上。

【规则6-3】枚举值从小到大顺序定义。

Class TestClass
{
public const double Pi = 3.14159365753;
private readonly double Pai = 3.14159365753;
}

g)接口

【规则7-1】接口的命名使用Pascal规则,即每个单词的首字母都要大写,且必须以大写“I”开头。

【规则7-2】如果类实现了接口,名称尽量和接口相同, 只是省掉“I”字符。

【规则7-3】接口名称要有意义,中间不要有下划线“_”等字符。

interface ITest
{
...
}

h)事件委托

【规则8-1】事件委托的命名使用Pascal规则,即每个单词的首字母都要大写。

【规则8-2】定义事件委托要使用EventHandler后缀,且包括sender和e两个参数。

【规则8-3】事件委托用到的参数,名称要带EventArgs后缀。

Class TestClass
{
private delegate void DoTask();
private event DoTask DoTaskEventHandler;
private event DoTask DoTaskEventHandler(Object sender,EventArgse);
private event DoTask DoTaskEventHandler2(string strEventArgs)
{
...
}
}

i) 命名空间

【规则9-1】命名空间的命名使用Pascal规则,即每个单词的首字母都要大写。

【规则9-2】命名空间名称尽量反映其内容所提供的整体功能。

namespace MyTest
{
Class TestClass
{
...
}
}



文章由安静原创,发表于www.ajnote.com。转载请注明出处

发表 2018年7月14日 自 anjing 类别 "C#学习笔记

发表评论

电子邮件地址不会被公开。 必填项已用*标注