文档介绍：编码及命名规范
整理人:陈春祥
日期:2011-01-04
适用范围
本文档适用人员范围:开发人员。
本文档适用开发范围:C#开发、JAVA开发。
注:本文档为使用进行开发的程序员提供编码规范的指导,其提供的一些编码通用规则也可以供使用其他语言编程的开发者参考。
第一部分命名规范
首字母大写样式
每个单词开头的字母大写(如TestCounter).
首字母小写样式
除了第一个单词外的其他单词的开头字母大写. 如. testCounter.
全字母大写样式
全部单词都大写,单词间以“_”符号隔开。尽量少用缩写命名. 如. TEST_COUNTER.
 名称
所有命名都应该尽可能使用完整的词,例如 SpellCheck。缩写词可能有许多种形式,因此可能产生混淆。请注意:缩写词可能很难理解。如果整个单词太长,则使用完整的第一音节或经过仔细选择的缩写词。
 区分大小写
为了避免混淆和保证跨语言交互操作,请遵循有关区分大小写的使用的下列规则:
。对于区分大小写和不区分大小写的语言,组件都必须完全可以使用。不区分大小写的语言无法区分同一上下文中仅大小写不同的两个名称。因此,在创建的组件或类中必须避免这种情况。
。例如,不区分大小写的语言无法区分以下两个命名空间声明。
             namespace ;
             namespace ;
。下面的示例是不正确的。
            void MyFunction(string a, string A)
。在下面的示例中,Point p 和 POINT p 是不适当的类型名称,原因是它们仅在大小写方面有区别。
          p
          p
。在下面的示例中,int Color 和 int COLOR 是不适当的属性名称,原因是它们仅在大小写方面有区别。
          int Color {get, set}
          int COLOR {get, set}
。在下面的示例中,calculate 和 Calculate 是不适当的方法名称,原因是它们仅在大小写方面有区别。
          void calculate()
          void Calculate()
 缩写
为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则:
。例如,使用 GetWindow,而不要使用 GetWin。
。
,使用众所周知的缩写替换冗长的词组名称。例如,用 UI 作为 User Interface 的缩写,用 OLAP 作为 On-line Analytical Processing 的缩写。
。如果必须使用缩写,对于由多于两个字符所组成的缩写请使用首字母大写样式,虽然这和单词的标准缩写相冲突。
 命名指导
,尽可能使用完整的词.
,使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如,ApplicationException 对于从名为 Exception 的类派生的类是适当的名称,原因是 ApplicationException 是一种 Exception。请在应用该规则时进行合理的判断。例如,Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件,但是将 Control 作为类名称的一部分将使名称不必要地加长。
 接口命名规则
,尽可能使用完整的词. (Example IComponent or IEnumberable)
,并紧跟一个大写字母(即接口名的第一个字母大写)
 枚举命名规则
Enum 类型和值名称使用全字母大写样式。