C# 命名规范

来源:互联网 发布:南京浦口行知小学 编辑:程序博客网 时间:2024/05/20 09:22

Pascal:指名称中单词的第一个字母写,EmployeeSalary,ConfirmationDialog,PlainTextEncoding; camel:名称中第一个单词的第一个字母不是大写,如 employeeSalary,confirmationDialog,plainTextEncoding; C#中,命名空间,类,以及基类中的成员等名称遵循Pascal命名法,而传递给参数的所有参数,两个同名对象的区分用camel命名法,当然vb.net不区分大小写,需要区别对待。 遵循这样的约定是一个很好的习惯,并对许多开发团队和组织接受,可以方便更多人来阅读代码。

 

a)类

【规则1-1】使用Pascal规则命名类名,即首字母要大写。


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


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


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


【规则1-5】文件名要能反映类的内容,最好是和类同名。


b) 类字段


【规则2-1】用camel规则来命名类成员变量名称,即首单词(或单词缩写)小写。


【规则2-2】类字段变量名前可加“_”前缀。


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


c)方法


【规则3-1】方法名采用Pascal规则,第一个字符要大写。


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


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


d)属性


【规则4-1】使用名词定义属性,属性使用Pascal规则,首字符大写。


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


e)参数


【规则5-1】参数采用camel规则命名,且首字符小写。


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


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


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


f)常量


【规则6-1】只读常量使用Pascal命名规则,即首字母大写。


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


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


【规则6-4】静态字段或属性采用Pascal规则,即首字符大写。


g)接口


【规则7-1】接口定义使用Pascal规则,且必须以大写“I”开头。


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


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


h)事件


【规则8-1】委托名称采用Pascal规则,即首字符大写。


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


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


i)   C#语言命名空间


【规则9-1】命名空间名称采用Pascal规则,且首字符大写。


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


总结:

命名空间,类,事件,接口,常量,属性,方法使用Pascal命名,即首字母大写
参数,变量(类字段)使用camel命名法,即首字母小写。