大数跨境

简洁代码(clean code)的9个品质

简洁代码(clean code)的9个品质 Python程序员
2016-09-24
0
导读:你多久会在浏览他人的代码时大声说:“天哪,这真是辣鸡代码…”来表达你的不满?可能非常经常。而你又怎样确定没有人在使用你的代码时有相同的想法?换句话说,怎样确定你的代码是简洁的?事实是只有你完全知道简洁


Python部落(python.freelycode.com)组织翻译,禁止转载,欢迎转发。


文中链接无法点击, 可以在

python.freelycode.com/contribution/detail/453

查看链接可点击的文章.

你多久会在浏览他人的代码时大声说:“天哪,这真是辣鸡代码…”来表达你的不满?可能非常经常。而你又怎样确定没有人在使用你的代码时有相同的想法?换句话说,怎样确定你的代码是简洁的?事实是只有你完全知道简洁代码代表什么的时候你才能够回答上面的问题。

很难创造一个对简洁代码的精准定义,也许它的定义和程序员的数量一样多。然而,有些原则是可以应用到简洁代码的基础层面。我收集了9个最相关的原则,并将在下面简短地介绍他们。

1. 差的代码会做太多的事情——简洁代码则非常专一

每一个类,方法或者其他实体需要保持不动。它应该遵从SRP(Single Responsibility Principle,单一职责原则)。简单的说,我们可以说SRP(根据一些众所周知的定义)是关于确保如果你可以为改变一个类想到一个理由,你不应当为其找到超过一个理由。

然而,我不会仅仅将这个定义限制在类的观点里。在Ralf Westphal的最后一篇文章里,他陈述了单一职责原则的一个更广泛的定义。根据他的定义:

在一个给定的抽象层,一个功能单元仅仅应当为单方面系统需求负责。单方面需求指一个可以独立于其他方面而改变的需求的一个特性。

如果你想要阅读更多关于这个主题,我建议你深入研究他的文章。

2. 你代码的语言应当看起来像是为问题而设计的

不是语言本身使一个程序看起来简单,而是开发者让这个语言看起来简单。(引用自Robert C. Martin)

这意味着,例如,你不应当使用会使代码和语言看起来拙劣的变通方法。如果你说一件事只能以一种变通的方法完成,这通常意味着你没有花费足够的时间去寻找一个好的,简洁的解决办法。

3. 不要有冗余

简洁代码应当符合DRY规则(Don’t Repeat Yourself, 不要自我重复)。当DRY原则被成功应用后,对系统中任意单个元素的修改都不需要在其他逻辑上不相关的元素做修改。

4. 你的代码读起来应当很舒服

当浏览你的代码时你应当感觉是在读哈利波特(是的我知道这有些夸张J)。你应当感觉到这个代码是可以给任何开发者简单地阅读而不需要花数小时深入理解它。

为了实现这个,你可以尝试去遵守KISS原则(Keep It Simple, Stupid! 保持简单,笨蛋!)以及YAGNI原则(You Ain’t Gonna Need It, 你不会需要它)。KISS原则表示大多数系统,如果它们能保持简单而不是复杂,那么它们就能最好地工作。

因此,简单应当在设计中是一个关键目标,要避免不必要的复杂度。YAGNI是一个鼓励你单纯地关注于可以让你的软件工作的最简单的事情的一个实践。

5. 易于被其他开发者扩展

你不是在给你自己写代码,或者更糟的——为编译器写代码。你是为其他开发者写代码。不要太自私——想想其他人。不要写一个极难维护与扩展的代码来折磨其他开发者。不要忘了,过几个月你自己可能就会成为“其他开发者”中的一员了。

6. 有最少的依赖库

依赖库越多,未来修改及维护起来就更难。你可以通过使用诸如NDEPEND等工具来检查你代码中潜在的依赖库的错误,从而帮助你实现减少依赖库的目标。

7. 越小越好

代码应当很小。所有类与方法都应当短小精悍,最好只有几行代码。它应当被很好区分开(在一个类内部也同样)。你区分的越好,它就越容易阅读。这个原则可能会正面影响第4点——它使得其他开发者更容易理解你的代码。

8. 应当有单元化的验收测试

如果我们不写测试,我们怎么能知道我们的代码是否符合需求呢?我们怎么能维护并扩展它而不去担心它会停止工作呢?没有测试的代码是不简洁的。如果你想知道更多关于单元测试的内容,我建议你去阅读一篇非常好的文章Three Pillars of Unit Tests,这是我的一个同事写的。

9. 应当富有表现力

代码的表现力代表它有着有意义的名字。这些名字应当表达了它们的意图。它们不应当误导你。它们应当是特别的。表现力可以让代码本身变成文档,从而使文档不再那么重要。如果你想阅读更多关于自文档代码的本质我建议你浏览这篇文章。

所以究竟什么是简洁代码的定义呢?

总之,有一个最终品质可以总结上述内容:

简洁代码是由用心的人写成的代码。(引用自Michael Feathers)

即,简洁代码是由那些视其为艺术并关注所有细节的人写成的。

事实上,简洁代码的主旨非常复杂,远超出这篇帖子中所包含的知识。因此如果你发现任何其他的你认为可以让代码更加简洁的特性,请和我们分享吧!


英文原文:https://blog.goyello.com/2013/01/21/top-9-principles-clean-code/
译者:hanhan


【声明】内容源于网络
0
0
Python程序员
1234
内容 2525
粉丝 0
Python程序员 1234
总阅读0
粉丝0
内容2.5k