名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。
命名原则是:
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称,如方面名 AnalyzeThis(),或者属性名 xxK8。这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的,如 Book.BookTitle。而是应该使用 Book.Title。
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 以便于维护和理解。
- 第一章 概述
- 1.1规范制定原则
- 1.2 术语定义
- 1.3 文件命名组织
- 1.3.1文件命名
- 1.3.2文件注释
- 第二章 编码风格
- 第三章 注释
- 3.1 注释概述
- 3.2 文档型注释
- 3.3 类c注释
- 3.4 单行注释
- 3.5 注释标签
- 第四章 声明
- 4.1每行声明数
- 4.2初始化
- 4.3位置
- 4.4类和接口的声明
- 4.5字段的声明
- 第五章 命名规范
- 5.1命名概述
- 5.2大小写规则
- 5.3缩写
- 5.4命名空间
- 5.5类
- 5.6接口
- 5.7属性 (Attribute)
- 5.8枚举 (Enum)
- 5.9参数
- 5.10方法
- 5.11属性 (property)
- 5.12事件
- 5.13 常量 (const)
- 5.14 字段
- 5.15 静态字段
- 5.16 集合
- 5.17 措词
- 第六章 语句
- 6.1每行一个语句
- 6.2 复合语句
- 6.3 return 语句
- 6.4 if、 if-else、if else-if 语句
- 6.5 for、foreach 语句
- 6.6 while 语句
- 6.7 do - while 语句
- 6.8 switch - case 语句
- 6.9 try - catch 语句
- 6.10 using 块语句
- 6.11 goto 语句
- 第七章 函数与类
- 第八章 内存分配和释放
- 第九章 兼容性
- 第十章 控件命名规则
- 10.1 命名方法
- 10.2 主要控件名简写对照表
- 附录一: 匈牙利命名法