函数

简介

    函数是代码的灵魂,函数的好坏直接体现代码的质量,决定代码的可读性。

应遵循的规则

函数编写应该遵循一些基本的规则。

短小

       冗长的函数会增加代码阅读的复杂性,极大降低代码的阅读速度。函数编写最主要的规则是短小。上世纪的共识是函数的长度不应该长于一屏,而如今随着显示技术的发展,一些优秀的工程师建议函数长度不应该超过100行,20行封顶为最佳。在代码的逻辑中,时常包含诸如if,else等逻辑判断代码以及while等循环逻辑代码, 合理的建议是这些判断和循环逻辑中的代码块应该只包含一行语句,这行语句一般就是一个函数调用,如此不但可以保持函数短小,还可以通过代码块中调用函数的名称增强文档的价值。函数不应该大到足以容纳所有的嵌套结构,函数的缩进层级不应该多于一层或者两层,这样可以便于代码的阅读以及理解。

只做一件事

       强烈建议一个函数应该只是完成一件事,做好一件事,只做一件事。函数内的逻辑应该清晰明了,降低代码间的耦合度,一个合理的函数应该是“原子”的,也就是不可以再拆分成多个函数。

合理的抽象层级

       要想保证函数只是做好一件事,那么函数中的语句应该都在一个抽象层级上。混杂不同抽象层级的函数很容易会让读者产生困扰,读者很可能无法判断某个表达式是基础概念还是细节,而一旦细节与基础概念混杂,更多的细节就会在函数中纠结起来。我们总是以自顶向下的顺序阅读代码的。编写代码时应该时时注意向下规则,在当前函数中只是描述当前抽象层级,并且引用下一层级。

使用描述性的名称

      在上一章《有意义的命名》中详细讲过函数的命名,在这里再次强调函数命名要使用描述性的名称。如果我们坚持了上述只做一件事的规则,那么我们的函数就短小、功能集中,函数越短小,功能越集中,函数名称越好取。花时间取个好名字是值得的,这有助于理清模块的设计思路。

函数参数

     函数的参数应该越少越好,零参是最理想的情况,除非有充足的理由,要不然不要轻易使用三个以上的参数。函数的参数越多,要覆盖所有情况的测试用例组合就越多,这将极大的增加测试的复杂性。

减少重复性

    代码编写最忌讳重复造轮子,我们一定要将重复的代码抽象出来组成新函数以供调用。

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