名字很重要

是什么

在编程中,我们要将命名视为最重要的课题,谨慎对待。

“命名”这一行为和它的产物“名字”都具有非常重要的价值。

  • 命名

取了一个合适的名字意味着元素被正确理解并被正确地设计了出来。相反,如果取的名字不合适,就证明程序员还没有充分理解该元素的作用

  • 名字本身

程序员之间通过代码进行交流时,名字传递的信息是最多的。

写代码的人和读代码的人很少能站在一起实时进行对话。程序员之间大多通过代码进行交流,一旦名字不够贴切,代码上的沟通就会出现障碍。

为了让这种非实时对话能够顺畅进行,我们必须最大限度地在名字上下功夫。

为什么

名字是面向代码阅读者的“用户界面”。各元素都有适当名字的代码能有效传达其意图,让人充分理解某个东西是怎么做出来的。

以给函数命名为例,名字恰当易懂的函数能通过名字表达其职责,这有助于隐藏函数的内部处理。从结果来看,有以下好处。

  • 在阅读代码时,只看函数名就能大致掌握其内部处理,因此可以跳着阅读内部代码。
  • 在编写代码时,函数名能帮我们理解该函数的目的以及用法,使函数调用变得简单。对编写完的代码来说,恰当的名字起到了说明作用,使代码的可读性大大提高。

程序员并不是因为想读代码才去读的,在充分理解代码之后对其进行修改或添加功能才是他们真正的目的。在阅读代码时,混乱的名字会占用所有的脑部资源,妨碍原本应该进行的作业,使程序员无法着手处理问题。

琢磨名字需要花费很多精力,要想取一个恰当的名字,我们得有强大的思考能力,还要舍得花时间。相反,随便取一个名字不仅不会影响函数的运行,还能节约时间。

不恰当的名字会让代码“负债”,此后,只要代码还在使用,读代码的人、用代码的人都将会受到负面影响。

怎么做

编程要先从名字入手,先给代码中会出现的各个元素取一个能够准确表达意图的名字。

在编写代码的过程中也要时常站在代码使用者和阅读者的角度命名。具体来说,注意以下几点:

  • 名字中尽量多包含信息。将名字视为简短的注释有助于将必要的信息添加进去,可以多准备几个名字,从中选择最合适的一个,这样能进一步提高名字的质量。
  • 名字不能有歧义。命名之后,多问自己几遍这个名字是否有歧义
  • 名字说明的是效果和目的,而不是手段。
  • 可以通过先写测试程序后,后写处理的方式检查一下自己取的名字是否合适。
  • 名字要能念出来,除了便于现实对话之外,还能减轻阅读代码时大脑的负担
  • 名字要能搜索出来,名字如果是一个字母或一个数字,搜索时就会产生无数个结果,给代码的解析带来额外的负担。

猜你喜欢

转载自blog.csdn.net/u012069234/article/details/111058423