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

编码及命名规范范围 本文档范围：开发人员。本文档范围：。本文档为使用进行开发的程序员提供编码规范的指导，其提供的一些编码通用规则也可以供使用其他语言编程的开发者参考。大写样式每个单词开头的字母大写(如TestCounter). 除了第一个单词外的其他单词的开头字母大写. 如. testCounter. 全部单词都大写，单词间以“_”符号隔开。尽量少用缩写命名. 如. . 2.命名指导 ?名称 所有命名都应该尽可能使用完整的词，例如 SpellCheck。缩写词可能有许多种形式，因此可能产生混淆。请注意：缩写词可能很难理解。如果整个单词太长，则使用完整的第一音节或经过仔细选择的缩写词。2.2?区分大小写 为了避免混淆和保证跨语言交互操作，请遵循有关区分大小写的使用的下列规则：不要使用要求区分大小写的名称。对于区分大小写和不区分大小写的语言，组件都必须完全可以使用。不区分大小写的语言无法区分同一上下文中仅大小写不同的两个名称。因此，在创建的组件或类中必须避免这种情况。不要创建仅是名称大小写有区别的两个命名空间。例如，不区分大小写的语言无法区分以下两个命名空间声明。???????????? namespace ee.cummings;???????????? namespace Ee.Cummings;不要创建具有仅是大小写有区别的参数名称的函数。下面的示例是不正确的。 ??????????? void MyFunction(string a, string A)不要创建具有仅是大小写有区别的类型名称的命名空间。在下面的示例中，Point p 和 POINT p 是不适当的类型名称，原因是它们仅在大小写方面有区别。 ????????? System.Windows.Forms.Point p????????? System.Windows.Forms.POINT p 5.不要创建具有仅是大小写有区别的属性名称的类型。在下面的示例中，int Color 和 int COLOR 是不适当的属性名称，原因是它们仅在大小写方面有区别。 ????????? int Color {get, set}????????? int COLOR {get, set}不要创建具有仅是大小写有区别的方法名称的类型。在下面的示例中，calculate 和 Calculate 是不适当的方法名称，原因是它们仅在大小写方面有区别。 ????????? void calculate()????????? void Calculate() 2.3?缩写 为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用 GetWindow，而不要使用 GetWin。 不要使用计算机领域中未被普遍接受的缩写。在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 作为 User Interface 的缩写，用 OLAP 作为 On-line Analytical Processing 的缩写。不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请使用，虽然这和单词的标准缩写相冲突。 2.4?命名指导 类名应该为名词及名词短语，尽可能使用完整的词.使用不要使用类前缀在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，原因是 ApplicationException 是一种 Exception。请在应用该规则时进行合理的判断。例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，但是将 Control 作为类名称的一部分将使名称不必要地加长。 2.5?接口命名规则 接口名称应该为名词及名词短语或者描述其行为的形容词，尽可能使用完整的词. (Example IComponent or IEnumberable)使用使用字符I为前缀，并紧跟一个大写字母（即接口名的第一个字母大写） 2.6?枚举命名规则 对于 Enum 类型和值名称使用。少用缩写。 不要在 Enum类型名称上使用 Enum 后缀。 2.7只读及常量变量命名 静态常量使用名词及名词短语2.使用2.8参数及非常量变量命名 使用描述性的命名，名称应该明确表达参数的意义及类型，优先满足参数的意义描述使用对或前缀。UI类的变量命名使用如下规则 TextBox类：前缀txt+名称（），如：txtCustomerName; Label类：前缀lbl+名称（），如：lblCustomerName; Select类：前缀se