文档介绍:命名规范
(一) 命名概述
名称应该说明“什么”而不是“如何”。通过避免使用复杂的逻辑语言,而是使用更容易理解的普通语言。例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。
以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称,如方面名 AnalyzeThis(),或者属性名 xxK8。这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的,如 。而是应该使用 。
3、只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。
4、在变量名中使用互补对,如 min/max、begin/end 和 open/close。
5、布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False 值,如 fileIsFound。
6、在命名状态变量时,避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag,而是使用更具描述性的名称,如 documentFormatType。
7、即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如 i 或 j。可能的情况下,尽量不要使用原义数字或原义字符串,如
For i = 1 To 7。而是使用命名常数,如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。
(二) 大小写规则
大写
标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如:
下表汇总了大写规则,并提供了不同类型的标识符的示例。
标识符大小写示例
类 Pascal AppDomain
枚举类型 Pascal ErrorLevel
枚举值 Pascal FatalError
事件 Pascal ValueChange
异常类 Pascal WebException 注意总是以 Exception 后缀结尾。
只读的静态字段 Pascal RedValue
接口 Pascal IDisposable 注意总是以 I 前缀开始。
方法 Pascal ToString
命名空间 Pascal
属性 Pascal BackColor
公共实例字段 Pascal RedValue 注意很少使用。属性优于使用公共实例字段。
受保护的实例字段 Camel redValue 注意很少使用。属性优于使用受保护的实例字段。
私有的实例字段 Camel redValue
参数 Camel typeName
方法内的变量 Camel backColor
(三) 缩写
为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则:
1 不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用 GetWindow,而不要使用 GetWin。
2 不要使用计算机领域中未被普遍接受的缩写。
3 在适当的时候,使用众所周知的缩写替换冗长的词组名称。例如,用 UI 作为 Use