5.4 命名
计算机不关心如何命名变量以及函数,编译器以及链接器也不关心命名的方式,只要名称与其他变量或者函数不发生冲突即可。名称可以帮助您以及您的同事理解程序的各个元素,但是程序员在他们的程序中经常使用含糊或者不合适的名称,这种情况多得让人吃惊。
5.4.1 选择一个恰当的名称
变量、方法、函数或者类的名称应该能够精确描述其目的。名称还可以表达额外的信息,例如类型或者特定的用法。当然,真正的考验是其他程序员是否理解您通过某个特定的名称所要表达的意思。
您所在组织可能会有命名规则,除此之外并没有固定的规则。然而,有些名称基本上是不恰当的。表5-1显示了一些好的名称以及不好的名称。
表 5-1
|
好 名 称< xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" /> |
坏 名 称 |
|
srcName, dstName
区别两个对象 |
thing1, thing2
太一般 |
|
gSettings
表明全局身份 |
globalUserSpecificSettingsAndPreferences
太长 |
|
mNameCounter
表明了数据成员身份 |
mNC
太简单,太模糊 |
|
performCalculations()
简单,明确 |
doAction()
太一般,不准确 |
|
mTypeString
赏心悦目 |
_typeSTR256
只有计算机才会喜欢的名称 |
|
mWelshRarebit
好的内部玩笑 |
mIHateLarry
不恰当的内部玩笑 |
前面的表格提到了mNC,作为成员变量这个名称太模糊太简单了。然而,对于作用域非常有限的局部变量,允许使用短名称,例如: