【原】恰当易懂的命名与晦涩难懂的命名

代码中有各种名字：变量名、函数名……，读代码时名字是最常见的能够涵盖很多信息。如果这些名字能有效传达其意图，代码可读性较高。

以函数名为例，恰当易懂的函数名有以下好处：

• 在阅读代码时，只看函数名就能大致了解其内部处理，因此可以跳过阅读内部代码；

• 在编写代码时，函数名能帮助我们理解该函数的目的及用法，使函数调用变得简单。

相反，晦涩难懂的函数名会给代码增加很大的负担，具体来说有以下几点：

• 在阅读代码时，如果无法通过函数名了解处理内容，读代码的人将被迫深入阅读代码。如果函数嵌套层数很多，读代码的负担会非常重；
  ● 在编写代码时，如果无法通过函数名进行各种判断，就需要对函数内部进行解析，代码会因所调用的函数的名字不当而看上去支离破碎，变得难以读懂。

所以，程序员编码时应当学会取名。而要取一个能准确表达意图的名字，需要站在代码使用者和阅读者的角度命名。具体来说，应当注意以下几点：

• 名字中要尽量包含更多信息。名字要表明该元素的意图，可能需要不只一个单词，但是过长的名字也不利于理解，所以名字应当在字符长度和有意义之间取舍；

• 名字不能有歧义。要想减少歧义，就需要了解并遵循各编程语言的习惯；

• 名字说明的是效果和目的，而不是手段。只有名字说清楚了效果和目的，读代码和使用代码的人就能快速理解代码内容；

• 从使用者的角度来检查名字是否合适。可以通过先写测试程序后写处理的方式来检查一下取的名字是否合适；

• 名字要能念出来。能念出来的名字还可以减轻阅读代码时大脑的负担，也便于交流；

• 名字要能搜索出来。名字不能是一个字母或是一个数字，这样的名字搜索时就会在代码中产生无数个结果。而这会给代码解析带来额外的负担。

这正是：

编码名字很重要，恰当易懂好处多
取好名字有方法，拿去参考遵循它

参考书目：编程的原则：改善代码质量的101个方法，作者：上田勋，译者： 支鹏浩，出版社： 人民邮电出版社