文档章节

30 多年的编码经验浓缩成的 10 条最佳实践

编辑部的故事
 编辑部的故事
发布于 2017/08/29 19:37
字数 1362
阅读 7651
收藏 248

所以,如何写出一手好代码?

良好的代码更易于阅读、理解、调试和修改,最重要的是它的缺陷也更少。显然,编写良好的代码需要更多的时间,但是从长远来看,它也具有更多的价值,因为这降低了维护的成本,而且具有更好的可重用性。

事实上,我们可以将好的代码等同为可重用的代码,这也是本篇文章罗列的许多技巧背后的驱动原则。作为一个要实现特定功能的开发者,代码可以实现你的短期目标,但如果没有其他人希望重用它(包括未来的自己),这些代码一定会缺失某些东西。无论它是太复杂,还是太具体,在不同情况下都有很大可能会出错,或者不被其他开发者信任。

我发现,只要尝试坚持将下面的最佳实践应用于你编写的所有代码(包括你的实验和原型),无论你现在的经验水平如何,都会编写出更好的代码。

1. 遵循单一职责原则

函数是程序员的工具中最重要的抽象形式。它们能更多地被重复使用,你需要编写的代码就越少,代码也因此变得更可靠。较小的函数遵循单一职责原则更有可能被重复使用。

2. 尽量减少共享状态

你应该尽量减少函数之间的隐式共享状态,无论它是文件作用域的变量还是对象的成员字段,这有利于明确要求把值作为参数。当能明确地显示函数需要什么才可以产生所需的结果时,代码会变得更容易理解和重用。

对此的一个推论是,在一个对象中,相对于成员变量,你更应该优先选择静态的无状态变量 (static stateless variables)。

3. 将“副作用”局部化

理想的副作用(例如:打印到控制台、日志记录、更改全局状态、文件系统操作等)应该被放置到单独的模块中,而不是散布在整个代码里面。函数中的一些“副作用”功能往往违反了单一职责原则。

4. 优先使用不变的对象

如果一个对象的状态在其构造函数中仅被设置一次,并且从不再次更改,则调试会变得更加容易,因为只要构造正确就能保持有效。这也是降低软件项目复杂性的最简单方法之一。

5. 多用接口少用类

接收接口的函数(或 C++ 中的模板参数和概念)比在类上运行的函数更具可重用性。

6. 对模块应用良好的原则

寻找机会将软件项目分解成更小的模块(例如库和应用程序),以促进模块级别的重用。对于模块,应该遵循的一些关键原则是:

  1. 尽可能减少依赖
  2. 每个项目应该有一个明确的职责
  3. 不要重复自身

你应该努力使你的项目保持小巧和明确。

7. 避免继承

在面向对象编程中,继承 —— 特别是和虚拟函数结合使用时,在可重用性方面往往是一条死胡同。我很少有成功的使用或编写重载类的库的经历。

8. 将测试作为设计和开发的一部分

我不是测试驱动开发的坚定分子,但开始编码时先编写测试代码会使得代码十分自然地遵循许多指导原则。这也有助于尽早发现错误。不过要注意避免编写无用的测试,良好的编码实践意味着更高级别的测试(例如单元测试中的集成测试或特征测试)在揭示缺陷方面更有效。

9. 优先使用标准库而不是手写的

我经常看到更好版本的 std::vector 或 std::string,但这几乎总是浪费时间和精力。一个明显的事实是 —— 你正在为一个新的地方引入 bug,其他开发者也不太可能重用你的代码,因为没有被广泛理解、支持和测试。

10. 避免编写新的代码

这是每个程序员都应遵循的最重要的教诲:最好的代码就是还没写的代码。你写的代码越多,你将遇到的问题就越多,查找和修复错误就越困难。

在写一行代码之前先问一问自己,有没有一个工具、函数或者库已经实现了你所需要的功能?你真的需要自己实现这个功能,而不是调用一个已经存在的功能吗?

写在最后的话

我发现编程是一门与学习艺术或运动非常相似的技能,你通过刻意的练习和从别人的经验中学习会得到更好的结果。不断提升你产出的代码质量有助于你成为更优秀的程序员。

译自:https://cdiggins.github.io/

© 著作权归作者所有

共有 人打赏支持
编辑部的故事

编辑部的故事

粉丝 1200
博文 252
码字总数 445830
作品 0
深圳
运营/编辑
私信 提问
加载中

评论(52)

久永
久永
以20年编程经验的来说,很赞成文章的总结,也因此总是被老板叫成(慢得像头)老牛。
我的名字叫李猜
我的名字叫李猜

引用来自“bappyfei”的评论

1.对自己好点 2.早点结婚 3.多陪陪家人 4.多交些朋友 5.多出去走走
正解
mahengyang
mahengyang
将测试作为设计和开发的一部分
这条好像没有人评论啊,测试真的好烦
此网页不存在
国内一定得写烂代码,别人接都没法接那种,这才能体现出你的重要性,bug多还能体现出工作量,关键时刻修改重要bug,确保项目成功上线。写的那么好,谁都能看懂,谁来了都能干,要你干啥?连bug都没有,上班干啥去?
东兴帅哥
东兴帅哥
模块 设计让我很爽,为什么不让我用呢
谁说谁是谁的灰
谁说谁是谁的灰
一定要坐直
开源中国-首席村长
开源中国-首席村长
第7条我不认同,违反了装逼法则之一:继承是高级程序员的基本常态技能。
Rezeroer
Rezeroer
能传递函数的地方就不要用类,继承那一套
yak
yak
写出一手好代码 能买上北京的房子吗?
Chet_W
Chet_W
避免继承???
ECUG Con 2013技术交流会本月底深圳走起!!

ECUG即Effective Cloud User Group(实效云计算用户组)成立于07年的CN Erlounge II,由Go语言大中华区首席布道师、七牛云存储CEO许式伟发起,致力于分享Erlang、Golang等各种语言在分布式领...

丫头潘潘
2013/12/13
1K
9
javascript——从「最被误解的语言」到「最流行的语言」

JavaScript曾是“世界上最被误解的语言”,因为它担负太多的特性,包括糟糕的交互和失败的设计,但随着Ajax的到来,JavaScript“从最受误解的编程语言演变为最流行的语言”,这除了幸运之外,...

modernizr
2014/05/20
1K
12
J+互联网沙龙——大数据和云时代的修炼之道

时值暮春,许久不见,J+ 又带着对大家的想念归来了。作为2018年第一期活动,我们为大家准备了一些新鲜的内容,通过本期活动你能获取到从一名普通程序员进化成数据科学家的修炼之道,也能学习...

缪斯的情人
04/12
21
1
2018 DevSec中国行.武汉站

2018年,开源中国社区成立十周年。我们借由历年来源创会的成功经验,以及社区运营的成果,决定打造源创会之“DevSec中国行”(Development & Security)。 这一新的品牌,串联DevSec核心厂商...

OSC至尊宝
04/10
17
1
LiveVideoStack Meet:多媒体开发新趋势

2018年初的音视频技术生态并不平静,Codec的争夺进入群雄逐鹿的时代,AV1和国产的AVS2对HEVC发起了挑战;WebRTC 1.0版定稿打通了在浏览器、移动端乃至IoT上的多媒体通信;AI、区块链技术的发...

rpandora
06/25
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Kernel I2C子系统

备注:所有图片来源于网络 1,I2C协议: 物理拓扑: I2C总线由两根信号线组成,一条是时钟信号线SCL,一条是数据信号线SDA。一条I2C总线可以接多个设备,每个设备都接入I2C总线的SCL和SDA。I...

yepanl
昨天
5
0
VS2015单元测试

一、C++在VS2015上进行单元测试 1.创建单元测试项目; 2.包含#include "CppUnitTest.h"文件和using namespace Microsoft::VisualStudio::CppUnitTestFramework;声明; 3.类声明TEST_CLASS(Te...

极客行
昨天
4
0
制作Docker镜像,用来编译OpenJDK11源码

在《极简,利用Docker仅两行命令就能下载和编译OpenJDK11》一文中,我们用以下命令实现了OpenJDK11源码的编译: docker run --rm \ -it \ -v /usr/local/work/openjdksrc:/src \ bolingcaval...

陈刚生
昨天
4
0
Docker之容器日期解决

将业务应用制作成镜像,以容器的方式运行之后,发现在容器中获取的日期不是国内使用的东八区时间,这肯定不行的,应用与时间紧密相关,所以要解决这个问题。 由于我们的应用是基于Springboo...

克虏伯
昨天
3
0
深入Spring Boot:ClassLoader的继承关系和影响

前言 对spring boot本身启动原理的分析,请参考:http://hengyunabc.github.io/spring-boot-application-start-analysis/ Spring boot里的ClassLoader继承关系 可以运行下面提供的demo,分别...

横云断岭
昨天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部