函数

短小

函数的第一规则是要短小;第二条规则则是还要更短小
函数应该20行封顶。

  • 代码块和缩进
    if语句、else语句、while语句等,其中的代码块应该只有一行,该行大致是一个函数调用语句。这样不仅能保持函数短小,而且因为块内调用的函数拥有较具说明性的名称,从而增加了文档的价值。
  • 只做一件事
    函数应该做一件事。做好这件事。只做这一件事。
    判断函数是否做了不止一件事的一个方法就是能否再拆出一个函数,这个函数不是单纯的重新诠释其实现。
    只做一件事的函数无法被合理地切分为多个区段。
  • 每个函数一个抽象层级
    要确保函数只做一件事,函数中的语句都在同一抽象层级上。

自顶向下读代码:向下规则
我们想让代码拥有自顶向下的阅读顺序。我们想让每个函数后面都跟着位于下一抽象层级的函数,这样一来,在查看函数列表是,就能循抽象层级向下阅读。我们把这叫做向下规则。
换一种说法我们想要这样读程序:程序就像是一系列TO起头的段落,每一段都描述当前抽象层级,并引用位于下一抽象层级的后续TO起头段落。

  • switch语句
    对于switch语句,如果只出现一次,用于创建多态对象,并且隐藏在某个继承关系中,在系统其他部分看不见,就还能容忍。

使用描述性的名称

选择描述性的名称能理清关于模块的设计思路,有助于改进。
命名方式要保持一致。使用与模块名一脉相承的短语、名词和动词给函数命名。

函数参数

零参数函数 优于 单参数函数 优于 双参数函数;因尽量避免三参数以上的函数。
输出参数比输入参数要难以理解。我们惯于认为信息通过参数传入函数,通过返回值从函数输出。我们不太期望信息通过参数输出。

  • 一元函数
    向函数传入单个参数有两种极普遍的理由。

    1. 问关于那个参数的问题
    2. 操作参数

    还有一种不那么普遍但仍极有用的单参数函数形式,那就是事件。在这种形式中,有输入参数无输出参数。
    所以我们在命名时要注意名称的区别,让读者能轻易分辨是哪种类型。

  • 参数对象
    如果函数看起来需要二个、三个和三个以上参数,就说明其中一些参数应该封装成类。

  • 动词与关键词
    给函数起个好名字,能更好的解释函数的意图,以及参数的顺序和意图。对于一元函数,函数和参数应当形成一种非常良好的动词/名词对形式

其他

  • 分隔指令与询问
    函数要么做什么事,要么回答什么事,但二者不可兼得。函数应该修改某对象的状态,或者返回对象的有关信息。
  • 使用异常代替返回错误码
  • 抽离try/Catch代码块
  • 错误处理就是一件事
  • 别重复自己
  • 结构化编程
    每个函数、函数中的每个代码块都应该有一个入口、一个出口。这意味着每个函数中只该有一个return,不能有break或continue语句,而且永永远远不能用有goto语句。
    但是只要函数保持短小,偶尔出现的return、break或continue语句没有坏处。但是goto在小函数中应该尽量避免使用。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,884评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,212评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,351评论 0 360
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,412评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,438评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,127评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,714评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,636评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,173评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,264评论 3 339
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,402评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,073评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,763评论 3 332
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,253评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,382评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,749评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,403评论 2 358

推荐阅读更多精彩内容