开发代码编程命名规范.pdf

《开发代码编程命名规范.pdf》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、编码及命名规范整理人：陈春祥日期：2011-01-04适用范围本文档适用人员范围：开发人员。本文档适用开发范围：C#开发、JAVA开发。注：本文档为使用进行开发的程序员提供编码规范的指导，其提供的一些编码通用规则也可以供使用其他语言编程的开发者参考。第一部分命名规范1.大写样式1.1首字母大写样式每个单词开头的字母大写(如TestCounter).1.2首字母小写样式除了第一个单词外的其他单词的开头字母大写.如.testCounter.1.2全字母大写样式全部单词都大写，单词间以“_”符号隔开。尽量少用

2、缩写命名.如.TEST_COUNTER.2.命名指导2.1名称所有命名都应该尽可能使用完整的词，例如SpellCheck。缩写词可能有许多种形式，因此可能产生混淆。请注意：缩写词可能很难理解。如果整个单词太长，则使用完整的第一音节或经过仔细选择的缩写词。2.2区分大小写为了避免混淆和保证跨语言交互操作，请遵循有关区分大小写的使用的下列规则：1.不要使用要求区分大小写的名称。对于区分大小写和不区分大小写的语言，组件都必须完全可以使用。不区分大小写的语言无法区分同一上下文中仅大小写不同的两个名称。因此，在创

3、建的组件或类中必须避免这种情况。2.不要创建仅是名称大小写有区别的两个命名空间。例如，不区分大小写的语言无法区分以下两个命名空间声明。namespaceee.cummings;namespaceEe.Cummings;3.不要创建具有仅是大小写有区别的参数名称的函数。下面的示例是不正确的。voidMyFunction(stringa,stringA)4.不要创建具有仅是大小写有区别的类型名称的命名空间。在下面的示例中，Pointp和POINTp是不适当的类型名称，原因是它们仅在大小写方面有区别。Syst

4、em.Windows.Forms.PointpSystem.Windows.Forms.POINTp5.不要创建具有仅是大小写有区别的属性名称的类型。在下面的示例中，intColor和intCOLOR是不适当的属性名称，原因是它们仅在大小写方面有区别。intColor{get,set}intCOLOR{get,set}6.不要创建具有仅是大小写有区别的方法名称的类型。在下面的示例中，calculate和Calculate是不适当的方法名称，原因是它们仅在大小写方面有区别。voidcalculate()v

5、oidCalculate()2.3缩写为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：1.不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用GetWindow，而不要使用GetWin。2.不要使用计算机领域中未被普遍接受的缩写。3.在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用UI作为UserInterface的缩写，用OLAP作为On-lineAnalyticalProcessing的缩写。4.不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字

6、符所组成的缩写请使用首字母大写样式，虽然这和单词的标准缩写相冲突。2.4命名指导1.类名应该为名词及名词短语，尽可能使用完整的词.2.使用首字母大写样式3.不要使用类前缀4.在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException对于从名为Exception的类派生的类是适当的名称，原因是ApplicationException是一种Exception。请在应用该规则时进行合理的判断。例如，Button对于从Control派生的类是适

7、当的名称。尽管按钮是一种控件，但是将Control作为类名称的一部分将使名称不必要地加长。2.5接口命名规则1.接口名称应该为名词及名词短语或者描述其行为的形容词，尽可能使用完整的词.(ExampleIComponentorIEnumberable)2.使用首字母大写样式3.使用字符I为前缀，并紧跟一个大写字母（即接口名的第一个字母大写）2.6枚举命名规则1.对于Enum类型和值名称使用全字母大写样式。2.少用缩写。3.不要在Enum类型名称上使用Enum后缀。2.7只读及常量变量命名1.静态常量使用名

8、词及名词短语2.使用全字母大写样式2.8参数及非常量变量命名1.使用描述性的命名，名称应该明确表达参数的意义及类型，优先满足参数的意义描述2.使用首字母小写样式3.对类内的成员变量或静态变量不使用前缀。公有成员使用首字母大写样式私有成员使用首字母小写样式内部成员使用首字母小写样式静态变量使用全字母大写样式4.UI类的变量命名使用如下规则TextBox类：前缀txt+名称（首字母小写），如：txtCustomerName;Label类：前缀l