编码及命名规范
整理人:陈春祥 日 期:2011-01-04
适用范围
本文档适用人员范围:开发人员。
本文档适用开发范围:C#开发、JAVA开发。
注:本文档为使用进行开发的程序员提供编码规范的指导,其提供的一些编码通用规则也可以供使用其他语言编程的开发者参考。
第一部分 命名规范
1.大写样式 1.1 首字母大写样式
每个单词开头的字母大写(如TestCounter).
1.2 首字母小写样式
除了第一个单词外的其他单词的开头字母大写. 如. testCounter.
1.2 全字母大写样式
全部单词都大写,单词间以“_”符号隔开。尽量少用缩写命名. 如. TEST_COUNTER.
2.命名指导 2.1 名称
所有命名都应该尽可能使用完整的词,例如 SpellCheck。缩写词可能有许多种形式,因此可能产生混淆。请注意:缩写词可能很难理解。如果整个单词太长,则使用完整的第一音节或经过仔细选择的缩写词。
2.2 区分大小写
为了避免混淆和保证跨语言交互操作,请遵循有关区分大小写的使用的下列规则:
1.不要使用要求区分大小写的名称。对于区分大小写和不区分大小写的语言,组件都必须完全可以使用。不区分大小写的语言无
法区分同一上下文中仅大小写不同的两个名称。因此,在创建的组件或类中必须避免这种情况。
2.不要创建仅是名称大小写有区别的两个命名空间。例如,不区分大小写的语言无法区分以下两个命名空间声明。 namespace ee.cummings; namespace Ee.Cummings;
3.不要创建具有仅是大小写有区别的参数名称的函数。下面的示例是不正确的。
void MyFunction(string a, string A)
4.不要创建具有仅是大小写有区别的类型名称的命名空间。在下面的示例中,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}