您还未登录! 登录 | 注册 | 帮助  

您的位置: 首页 > 业务知识 > 正文

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

发表于:2017-10-23 作者:杨小乐译 来源:开发者技术前线
如何使代码变得更好?好的代码可以被识别为易于阅读、理解、调试和修改的代码,而且最重要的是很少有缺陷。显然,编写好的代码需要花费更多的时间,但从长远来看,它也有更多的价值,因为维护成本更低,而且更易于重用。

 

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

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

 

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