写好函数之要

我们每个人刚开始编程写代码时,函数总是写得冗长而复杂,有太多的缩进和嵌套循环,有过长的参数列表。函数名称是随意取的,也会有重复代码出现在不同函数体中。但是,这没有关系,写好函数重在细节+耐心打磨。我们需要多几次分解函数,修改函数名称,消除重复,重新安置函数,甚至拆散类。打磨函数,规范代码本身就是工匠精神的体现,所以这一切很正常。

如何写好代码中的函数?也许我们需要注意这些。

短小

俗话说:函数的第一规则是短小,第二规则是还要更短小。保证一个函数只做一件事,它最长不过20行左右。

在遇到if语句,else语句,while语句等,其中的代码应该只保持一行。该行大抵是一个函数调用语句。这样不但能保持函数短小,而且,块内调用的函数拥有较为具体说明性的名称,从而增加了代码的可读性。这样,函数的缩进层级不该多于一层或两层。

只做一件事

函数应该只做一件事。编写函数是为了把大一些的概念拆分为另一抽象层上的一系列步骤。函数只做一件事指的是在函数本身这一抽象层级上的一件事儿,具体的实现步骤,可以通过实现下一层级的函数来调用。

如果函数还可以拆分出另一个函数或者可以被划分为多个区段,则该函数违反了"一件事"原则。

每个函数一个抽象层级

函数中的语句都要在统一抽象层级上,你可能会调用某个较高层级的函数,例如实现猫图像识别的函数,但在该函数底部却输出该图像到磁盘上。调用猫识别的函数抽象较高,后面输出太过于具体,违反了"一个抽象层级"的原则。

switch语句

尽量避免使用switch语句,switch语句太长,它明显做了不止一件事。如果无法避免switch,尽量让每个分支在统一抽象级上。

使用描述性名称

函数一般是一个动宾短语,不用怕名称太长,尽量保持描述性。另外,在同一抽象层级上的函数保持函数命名方式一致。

函数参数

函数参数理想情况为0个,其次是1个,再次是2个,尽量避免3个。函数参数最好不作为返回值。如果确实有很多内容需要作为参数传进函数,可以归纳参数的一致性并封装成类,作为对象传进函数。

分割指令和询问

函数要么做了一件事,要么用于判断一件事。一个函数最好不要同时把做的事情和需要判断的条件放在一个函数体中。这属于两件事。

避免重复

不同的函数体中如果出现相同或者相似功能的语句,最好抽象成函数统一起来,避免代码冗余。

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

推荐阅读更多精彩内容