变量命名概要

变量命名

命名的一般注意事项

  • 名字是否完整的表达了变量所代表的含义
  • 名字是否足够长,让人一看就懂
  • 名字反映了现实世界中的问题,而不是编程语言中的解决方案
  • 如果有计算值限定符,它们是否被放在了后面 employCount employTotal
  • 是否使用Count和Index来代替Num

为特定的数据类型命名

  • 循环下标的命名有意义吗?(如果是多层嵌套要注意下标的命名)
  • 所有的临时变量都重新命名以更有意义
  • 当布尔变量为真时,变量名能准确表达其意义
  • 枚举类型的命名是否使用了前缀Color_Red Color_Blue
  • 具名常量根据其代表的实体,而不是它所代表的数字来命名

命名规则

  • 规则能够区分全局数据,类数据,和局部数据吗?
  • 规则能够区分类型名,具名常量,枚举类型和变量名吗? 如类型名用大小写混合,具名常量用全部大写
  • 规则能够区分子程序的输入和输出参数吗?
  • 规则尽可能的与语言规则标准兼容吗?

短名字

  • 除非有必要才用短名字
  • 是否避免了为了节省一个字而缩写的情况
  • 所有单词的缩写方式都一致吗
  • 名字能够读出来吗
  • 避免容易看错和读错的名字了吗? 如i 1 l, o 0 O等
  • 在缩写表里有对缩写进行说明吗

常见的命名问题

  • 容易让人误解的名字
  • 有相近含义的名字
  • 只有一两个字符不同的名字
  • 发音相近的名字
  • 包含数字的名字
  • 英语中经常拼错的名字
  • 与标准的子程序或预定义的变量名冲突的名字
  • 过于随意的名字
  • 含有难读字符的名字

要点

  • 名字要尽可能的具体。那些模糊的或者太通用的可以包含多种用途的名字通常都不是很好
  • 现代编程语言很少需要用到缩写
  • 代码阅读的次数要远多于编写的次数
  • 命名规则应该能够很好的区分全局数据,局部数据,类数据。它们还应该区分类型名,具名常量,枚举类型和变量名

Comments