高质量子程序3——一个好的名字

1、如何选择一个能够在恰当的抽象层次上描述子程序的名字?

描述子程序所做的所有事情,子程序的名字应当描述其所有的输出结果以及副作用。

如果一个子程序的作用是计算报表总额并打开一个输出文件,那么把它命名为ComputeReportTotals()就还不算完整。ComputeReportTotalsAndOpenOutputFile() 是很完整,但是又太长且显得有点傻如果你写的是有一些副作用的子程序,那就会起出很多又长又笨的名字。

解决的方法不是使用某个描述性较弱的子程序名,而应该换一种方式编写程序,直接了当地解决问题而不产生副作用。

避免使用无意义的、模糊或表述不清的动词,有些动词的含义非常灵活,可以延伸到涵盖几乎任何含义。

不要仅通过数字来形成不同的子程序名字,有个程序员把所有的代码都写成一个大的函数,然后为每行代码创建一个函数,并把它们分别命名为partl、Part2等。在此之后,他又创建了一个高层次的函数来调用这些部分 Partn() 。这种创建子程序和给子程序命名的做法实在是骇人听闻(我真希望这很少发生)。但程序员们有时会用数字来区分类似于OutputUser、OutputUser1和OutputUser2这样的子程序。

这些名字后面的数字无法显示出子程序所代表的抽象有何不同,因此这些子程序的命名也都很糟糕。

准确使用对仗词,命名时遵守对仗词的命名规则有助于保持一致性,从而也提高可读性,像first/last这样的对仗词组就很容易理解。

下面列出一些常见的对仗词组:

add/remove  increment/decrement  open/close  begin/end  insert/delete  show/hide  create/destroy  lock/unlock  source/target  first/last  mini/max  start/stop  get/put  next/previous  up/down  get/set  old/new

为常用操作确立命名规则,在某些系统里,区分不同类别的操作非常重要。而命名规则往往是指示这种区别的最简单也是最可靠的方法。比如,在一个项目的代码里,每个对象都被分配了一个唯一标识。我们需要为返回这种对象标识的子程序建立一个命名规则。

不然的话,到了项目中期,项目组中每个人都不得不花费不必要的精力,去记住每个对象上采用的获取唯一标识的语法细节。而这些问题完全可以通过建立获取唯一标识的命名规则而避免。

2、子程序名字不好的原因?

有时一个子程序中仅有的问题就是其名字表述不清,而子程序本身也许设计得很好, 但如果把它的名字由 Handleoutput() 改为 FormatAndPrintOutput() ,那你就很容易看清楚这个子程序的功能了。

还有另外一些情况,其中的动词之所以含糊,是由于子程序执行的操作就是含糊不清的。这种子程序的问题在于目的不明确,而其模糊不清的名字仅是一种表象。如果是这种情况,那么最佳的解决办法便是重新组织该子程序及任何与之相关的子程序,以便使它们都具有更为明确的目的,进而赋予其能够精确描述这些目的的更为清晰的名字。

3、子程序的名字可以写多长?

变量名的最佳长度是9到7个字符。研究表明,子程序通常比变量更为复杂,因此,好的子程序名字通常也会更长一些。

另一方面,子程序名字通常是跟在对象名字之后,这实际上为其免费提供了一部分名字。总的来说,给子程序命名的重点是尽可能含义清晰,也就是说,子程序名的长短要视该名字是否清晰易懂而定。

4、有返回值的函数的名字

给函数命名时要对返回值有所描述,因此,函数的命名要应该针对其返回值进行。比如说,customerId.next()、printer.isReady()和 pen.currentColor()都是不错的函数名,它们精确地表述了该函数将要返回的结果。

5、无返回值的函数的名字

给过程起名时使用语气强烈的动词加宾语的形式。一个具有功能内聚性的过程通常是针对一个对象执行一种操作。过程的名字应该能反映该过程所做的事情,而一个针对某对象执行的操作就需要一个动词+宾语形式的名字。

如printDocument()、checkOrderInfo()等,都是很不错的过程名。

在面向对象语言中,你不用在过程名中加入对象的名字(宾语),因为对象本身己经包含在调用语句中了。你会用document.print()、orderlnfo.check()等语句调用子程序。

而诸如 document.printDocument()这样的语句则显得太臃肿,并且当它们在派生类中被调用时也容易产生误解。如果Check(支票)类是从Document(文档)类继承而来的,那么check.print()就很显然表示打印一张支票,而 check.printDocument()看上去像是要打印支票簿或是信用卡的对账单,而不像是打印支票本身。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,560评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,104评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,297评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,869评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,275评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,563评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,833评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,543评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,245评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,359评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,006评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2 273
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2 268

推荐阅读更多精彩内容