【翻译】代码简洁之道

最近看到一篇文章,介绍了简洁代码的重要性以及我们要如何编写简洁的代码,粗略翻译后记录如下。

什么是简洁代码?

以下是简洁代码的特点:
1.必须要具有可读性;
2.必须是优雅的;
3.必须易于理解并且遵循单一责任原则;
4.必须易于修改和维护;
5.必须按照测试策略运行测试。

简洁代码的重要性

下面是一些编写简洁代码的优点:
1.解决问题变得更容易
干净的代码可以从根本上解决问题,软件设计和算法也变得更具有意向性、更优雅。

2.清晰的思想交流
干净的代码减少了团队开发人员之间发生误解和争执的可能性,最终减少 bug 的出现。

3.减少代码维护;
干净的代码更易于阅读和理解,所以不必花很多时间在理解这些函数代码上面,为更新、修改和扩展代码留出更多时间。

编写简洁代码的八个技巧

1.使用描述性名称;

函数或变量的名称应该尽可能具有描述性,函数名称应该以动词开头,例如,一个返回开发者名字的函数,应命名为getDeveloperName,而不是直接用name命名。

2.适当使用空白行编写更具可读性的代码;

使用空白行的优点如下:
①增加代码的清晰度;
②一条额外的空白行可以明确地指明函数结束的位置;
③空白行可以将变量声明和操作函数分隔开;
④返回值之前的一行有助于理解该操作;

3.一个函数中不得超过三个以上的参数;

在函数中使用一组参数,很难找到它们的使用位置。相反,只使用三个参数并在函数中遵循它们的逻辑是更有效的,并使代码变得清晰。
如果需要使用三个以上的参数,可以改为传一个对象到函数,并使用相关的键名调用

4.一个函数只执行一个任务;

开发者应该避免在一个函数中做很多件事情,一个模块内只能执行一个任务,有两个或更多的短函数也比一个复杂的函数要好得多。

5.函数必须简短;

如果需要一个复杂的函数,那么使用类更合理一些。函数必须只做一件事情,正如前面提到的,而且必须是简短的。

6.减少一行中的字符数;

避免一行代码过长,这样方便阅读。行的长度必须适应屏幕,这样就不需要水平滚动。许多代码开发工具都可以格式化代码让代码便于阅读。

7.使用注释

使用注释可以帮助维护代码,虽然描述性的函数名称和变量名称也可以避免写注释,但是并不推荐这样做。注释可以使代码更清晰和连贯。

8.commit 时记录描述性信息

提交代码时记录一条描述性消息对于将来理解代码的功能是有帮助的,应尽可能提供详细的描述。

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

推荐阅读更多精彩内容