30 多年的编码经验总结成 10 条最佳实践

欢迎Follow我的GitHub, 关注我的CSDN. 其余参考Android目录

所以,如何使代码变得更好?
好的代码可以被识别为易于阅读、理解、调试和修改的代码,而且最重要的是很少有缺陷。显然,编写好的代码需要花费更多的时间,但从长远来看,它也有更多的价值,因为维护成本更低,而且更易于重用。

事实上,我们可以将好的代码与可重用的代码等同起来,这是在这里列出的许多技巧背后的驱动原则。代码可能实现您的短期目标,作为一个特定功能的程序员,但是如果没有其他人希望重用它(包括您未来的自己),那么它一定是缺少某种方式。要么它太复杂,太具体,太可能在不同的环境下崩溃,或者不能被其他程序员所相信。

我发现,不断尝试将下面的最佳实践应用于您所编写的所有代码(包括您的实验和原型),无论您的经验水平如何,都能带来更好的代码。

1、遵循单一责任原则
函数是程序员最重要的抽象形式。它们可以重用的代码越多,编写的代码就越少,它们的可靠性也就越高。更小的函数遵循单一责任原则更有可能被反复使用。

2、减少共享状态
您应该隐式最小化函数之间的共享状态,无论它是文件范围的变量还是对象的成员字段,都有利于明确要求的值作为参数。当代码明确了该函数需要什么来产生期望的结果时,代码就变得更容易理解和重用。

在这种情况下,你应该更喜欢静态无状态变量,而不应该选择对象上的成员变量。

3、局部化副作用
理想的副作用(例如,打印到控制台、日志记录、改变全局状态、文件系统操作等等)应该放在单独的模块中,而不是分散在整个代码中。功能上的副作用常常违反单一责任原则。

4、喜欢不可变对象
如果一个对象的状态在其构造函数中被设置一次,并且再也不会发生变化,那么调试就变得容易得多了,因为只要构造正确仍然有效。这是减少软件项目复杂性的最简单方法之一。

5、接口/类
接受函数的接口(或在C++中使用模板参数或概念)比在类上运行的函数更具有可用性。

6、将好的原则应用于模块
寻找机会,将软件项目分解为更小的模块(例如,库和应用程序),以支持模块级的重用。模块的一些关键原则是:

1.最小化的依赖性
2.每个项目都应该有一个明确的职责
3.不要自我重复

你应该努力使你的项目小巧而明确。

7、避免深度继承
在面向对象编程中,继承,尤其是虚拟函数中,在可重用性方面往往是一个死胡同。我几乎没有成功地编写或使用那些重载类的库。

8、在设计和开发过程中进行测试
我并不是测试驱动开发的核心支持者,但是当您开始编写测试代码时,编写测试自然遵循了许多指导原则。它还可以帮助我们更早地发现n个错误。但是,要避免编写无用的测试,良好的编码实践意味着更高级别的测试(例如:集成测试或单元测试的特性测试)在揭示缺陷方面更有效。

9、更喜欢标准的库,而不是手写的库
我不能告诉你我多久看到一个更好版本的std::vector或std::string,但它几乎总是浪费时间和精力。除了你正在引入一个新的bug地方(参见10)外,其他程序员不太可能重用您的代码,而不是被广泛理解,支持和测试。

10、避免编写新的代码
这是每个程序员都应该遵循的最重要的提示:最好的代码是还没有写好的代码。你拥有的代码行数越多,你的缺陷就越多,发现和修复bug的难度就越大。
在编写一行代码之前,要问自己,是否有一个工具、函数或库已经完成了您所需要的功能。你真的需要自己实现的那个功能,而不是调用另一个已经存在的功能。

结束语
我发现,编程是一种非常类似于学习艺术形式或运动的技能,你通过有意识的练习和向他人学习而变得更好。不断努力提高你的代码质量将有助于你成为更高效的程序员。

译自:https://cdiggins.github.io/
译文:http://blog.csdn.net/xiaole0313/article/details/78310085

推荐阅读
学习资料(干货汇集)不断更新【更新于2017-9-17】
2017 年初、阿里、腾讯、百度、华为、京东、搜狗和滴滴面试题汇集(更新篇)
如果你喜欢上了一个程序员小伙,献给所有的程序员女友
是什么让你决定离开一家公司?
同时收到多家offer,怎样选择?

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,977评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,646评论 18 139
  • 天阶小雨雾蒙蒙,清颜素淡冷眉峰。 画堂春外千丝寄,难诉心头万种愁。 丙申槐月·随城
    墨月霜花阅读 157评论 2 1
  • 你好,易木.最近过的怎么样? 这几天天气很好,有点咳嗽.日子好像不要钱一样睡着躺着就过去了.就记得暖的刺眼的阳光和...
    大爱暖暖阅读 370评论 0 0
  • 1 昨天在一个综艺节目里看到介绍一家美食,店名叫“一笼小确幸”,主打产品是蒸点。主创人说店名的意义是“微小而确实的...
    书颜书语阅读 1,011评论 2 2