C#程序中的命名规范
C#程序中的命名规范
规范的命名有利于程序的开发和维护,下面介绍一套命名规则供读者参考。
对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。
命名原则:选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。因此,提供的名称要符合适用语言的规则和标准,并且长短适当。
在解决方案中文件的命名要和文件中的类名一致。
用名词或名词短语命名类。
用pascal规则来命名方法和类型,代码如下:
public class TextBox
// http://www.isstudy.com
{
public void DataBind()
{
}
}
所有的成员变量前加前缀m_,代码如下:
public class Database
{
public string m_connectionString;
}
接口的名称加前缀I。例如,声明一个名为Icompare的接口interface,代码如下:
interface ICompare
{
int compare();
}
方法的命名,一般将其命名为动宾短语。下面的代码命名了ShowDialog()、ShowDialog()和GetPath()3个方法。
//http://www.isstudy.com
ShowDialog()
CreateFile()
GetPath()
局部变量的名称要有意义.不要用x、y、z等。例如,一个用户的名字命名如下:
sting userName
用有意义的名字命名namespace,例如,产品名、公司名。一般都是公司名加产品名,例如,用MingriSoft.OA作为明日科技办公自动化系统的命名空间。
通过方法名应能看出其作什么,尽量不使用容易引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。
用有意义的、描述性的词语来命名变量。
不用缩写。用name、address、salary等代替nam、addr、sal。
不使用单个字母的变量,如I、n、x等。使用index、temp等,用于循环迭代的变量例外。
避免使用很多成员变量。声明局部变量,并传递给方法。不要在方法间共享成员变量。如果在几个方法间共享一个成员变量,那就很难知道是哪个方法在什么时候修改了它的值。
为自定义的异常类加上后缀Exception。
使用名词、名词短语或者名词的缩写命名静态字段。
在类属性的名称中包含类名是多余的,如Book.BookTitle,应该使用Book.Title。
在变量名中使用互补对,如 min/max、begin/end 和 open/close。
不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用GetWindow,而不要使用GetWin。
当类是接口的标准执行时,定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处是接口名前有一个I前缀。
命名控件时,应该将控件名称的前3位作为缩写。如Form控件命名为frmAddNew。