所有程序员都应该遵守的 11 条规则 已翻译 100%

oschina 投递于 2015/03/18 16:26 (共 13 段, 翻译完成于 03-20)
阅读 10694
收藏 206
22
加载中

我是一个倾向于生活在规则下的人。

现在,这些规则大部分是我本人为自己设立的-但它们依然是规则。

我发现为自己创建规则可以让我过得更好,因为这样做可以提前决定一些事情,而不是要在匆忙中做出所有的决定。

我今天早上应该去健身房吗?

我的规则告诉我说我要在周三前往健身房,今天是周三,因此我要去健身房,就这么办了!

这周,当我正在思考那些对我施加有影响的规则时,我想到了去制定一系列软件开发者都应该遵守的规则,我认为这可能是一个好主意。

现在,我承认,这里面的大多数规则比那些“指导方针”要求的要多,它们是:

北风其凉
北风其凉
翻译于 2015/03/18 22:24
2

1: 技术是你获取解决方案的方法,而不是解决方案本身

我们可以得意忘形地使用最新的JavaScript框架-嗯哼,Angular-IoC 容器,编程语言,甚至操作系统。但作为一个程序员,所有这些东西并不是问题真正的解决方案,相反,它们只是帮助我们解决问题的简单工具。

在面对那些我们喜欢或是当前非常流行的特殊技术时,我们必须非常小心,而不是变得过于疯狂。以免步入这样一个险境:仅仅因为我们手里拿了一把闪闪发亮的锤子,就把所有的问题都看作钉子。

北风其凉
北风其凉
翻译于 2015/03/18 22:42
2

2: 对代码而言,“聪明”是“清晰”的敌人

在写代码的时候,我们应努力保持书写的代码清晰易懂。

可以明确(Clear)表明自身意图的代码,永远要比那些晦涩的代码更有价值-无论那些晦涩的代码被构建得多么聪明(Clever)。

虽然情况并不总是这样,但一般来说,“聪明”是“清晰”的敌人。

一种经常出现的情况是,当我们写出一段“聪明”的代码时,这段代码并不是特别的“清晰”。

这条规则非常重要,尤其是当我们思考我们要做一些特别“聪明”的事情时。

有时候我们写出了“聪明”的代码,它们同时也是清晰的,但是其他情况也会时有发生。

如果你对写出简洁的代码感兴趣,我高度推荐你用下面这本书上描写的规则来检验:Robert C. Martin的《干净的编码者:专业程序员的行为守则》(The Clean Coder: A Code of Conduct for Professional Programmers)

北风其凉
北风其凉
翻译于 2015/03/18 23:54
1

3: 只在逼不得已的情况下才写代码

这条可能会有些争议,毕竟,作为程序员,我们的工作不就是写代码吗?

嗯。。。这个看你怎么说了。

写代码的确是我们工作的一部分,但是,我们要尽可能努力的去用最少的代码来解决问题。

所谓“最少的代码”并不是说我们只能用一个字母的变量名或者其它方式来压缩我们的代码。“最少的代码”指的是我们应该只写为了实现功能而必不可少的代码。

我们常常添加一些“酷”的功能,来让代码“健壮”和“灵活”,让代码能够处理“所有”可能的使用情况。我们企图猜测那些可能会被用到的功能。总之,我们常常花费时间去解决一些头脑中臆想出来的可能的情况。

我们这么做,是错的。

不能否认,这些多余的代码能会带来些好处。然而,这些代码同样的会有很多危害。我们写得代码越多,就越有可能引入错误;我们写得代码越多,将来的维护工作就越繁杂。

好的软件工程师只写绝对需要的代码。

伟大的软件工程师会把没用的代码统统都删掉。

nzchris
nzchris
翻译于 2015/03/19 09:09
1

4: 注释是魔鬼

我并不是很热衷于写注释。当我跟Bob Martin在一起时,他说:

“你写的每个注释,都代表着你表达能力的欠缺“

整洁代码:敏捷软件艺术手册

这并不是说一点注释也不写,但通常我们可以通过一种更好的方式——命名来避免。

注释仅在命名不能有效表示变量或方法的意图时才真正需要。此时的注释表达了不能用代码表达的真实意图。

例如,注释能够告诉你在代码中某些奇怪的操作顺序并不是错误的,它是由于底层系统的某一bug而有意为之的。

但通常,注释不仅没有必要,有时它们还会"撒谎".

注释没有随着代码更新的倾向,而这是很危险的,因为它们会将你带入歧途。

你会查检每条注释和与之对应的代码,确保代码是在做注释说的事么?如果是的话,写注释还有什么用?如果不是,你怎么相信注释说的是对的?

真他妈麻烦,所以最好还是尽量别写注释了。

OK,喷子们,在下面的评论区里留下你们的“口水”吧,但我会无视你们的。

pseudo
pseudo
翻译于 2015/03/20 13:38
1

5: 永远要在你开始写代码前考虑好它是做什么的

这一条看上去显而易见,然而事实并非如此。

想想你有多少次并没有完全想好就坐下来写代码,而这段代码确实实现了你要做的功能?

比之我乐于承认这个思路的正确性,我行动了更多次,这是一条我需要经常去品读的规则。

练习测试驱动开发(Test Driven Development,TDD)在这里会有所帮助,因为你在写出代码前,必须逐字的了解它们会做些什么,但是这依然无法阻止你去做错的事情。因此,在构建一个特性或功能前,保证自己百分之百地理解需求,也是很重要的。

北风其凉
北风其凉
翻译于 2015/03/18 22:58
1

6: 在交付之前,测试你的代码

别把你的代码直接扔给QA,然后指望着所有人来浪费时间为你服务。

事实上,你自己认真的运行一下测试案例,是完成代码之前必不可少的一步。

这并不是说一定让你自己找到代码中所有的问题,但是你至少得把那些愚蠢得令人尴尬的错误找出来吧?

很多软件工程师都觉得测试代码是QA的工作。这个想法绝对是大错特错。保证代码的质量,是每个人的工作!

nzchris
nzchris
翻译于 2015/03/20 06:31
1

7: 每天学点新东西

如果你每天都不学新知识,你就在退步,因为我可以保证你会忘记一些东西。

每天学一些新东西,并不会花去你太多的时间。

试着花15分钟去读一本书-我去年读了一大堆书,平均每天要花45分钟在阅读上

每天的小进步,随着时间的推移会积少成多,并在很大程度上重塑你的未来。如果你想在未来获取回报,你现在就需要开始投资了。

此外,今天的技术变化非常之快,如果你不能做到不断提高已有技能并学会新的技能,你会很快掉队。

北风其凉
北风其凉
翻译于 2015/03/18 23:35
2

8: 写代码是件快乐的事

诚然,你最开始进入这个行业可能只是因为它待遇优厚。

我是说,为了良好的待遇找工作没有任何错误,但是医生或律师可能会是更好的选择。

你之所以成为了一名软件开发人员,是因为你爱写代码。因此,不要忘记你在做你所热爱的事情。

写代码有很多乐趣,我希望我能写更多的代码。

我这几天经常忙于写代码并试图让它占据我更多的时间,这也是我为什么如此清晰地记得它有多么的有趣。

也许你已经忘记了写代码的乐趣,也许是时候你应该再次记起写代码是多么的有趣了-通过开始一个边角的项目,或是仅仅改变你的心态,意识到你开始写了代码,并为之付出。(但愿如此)

北风其凉
北风其凉
翻译于 2015/03/18 23:10
1

9: 你无法完全了解它

无论你学了多少知识,都会有大量你所不知道的东西。

认识这一点非常重要,因为你可以驾驭你的那些想要去学会所有东西的发狂的想法

没能获取所有问题的答案,这挺好的。

在自己不理解某事时寻求帮助或说出来,这也挺好的。

在很多情况下,你可以相当接近地了解到你想知道的事情-相信我,我一直在这样做。

我的观点是,不要总想着学会一切-如果这是个不可能完成的任务。相反,你应该重点学习那些你需要去知道的东西,并且提升那些可以让自己学习速度加快的能力

北风其凉
北风其凉
翻译于 2015/03/18 23:22
1
本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接。
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。
加载中

评论(48)

黑人牙膏
黑人牙膏

引用来自“ViaYang”的评论

4: 注释是魔鬼。这句话无疑是错误的,正确的是:糟糕的注释是魔鬼。很多时候,我们写注释并不仅仅是为了说明代码的逻辑,更多的时候是为说明类和函数的功能、使用范围、参数性质,更胜者,在某个复杂的设计模式里面,完全可以在注释里给出使用的范例。写好注释不是一个程序员应该做好的事,而是必须做好的事,所有写不好注释的程序员都还停留在初级阶段。毕竟,toString()返回的值到底是什么,光看函数名我们可不知道,难道不是吗?
这个我认同
黑人牙膏
黑人牙膏

引用来自“黑人牙膏”的评论

注释是魔鬼,我不认同,注释是团队合作里很重要的因素,按照此说法,jdk的源代码就是魔鬼了,觉得是胡说八道

引用来自“jQer”的评论

“你写的每个注释,都代表着你表达能力的欠缺“
别人说的未必是我认同的,我觉得写注释刚好是要用来表达我的思路,如果某个方法的逻辑比较复杂,你用注释和让人家看代码,哪个效率高点?jdk源码里大把的注释,spring和其他框架也很多注释,按照你的理解,他们都是渣渣了。因为他们的表达能力欠缺。。
黑人牙膏
黑人牙膏
注释跟好不好的命名没啥直接关联,注释多数是用来解释里面的方法有些需要特别注意的逻辑,参数的一些各种条件等,这些难道叫人家特意去看你的代码啊?不写好注释我个人觉得就是对自己队友不负责任的表现,也是自己懒惰的象征
黑人牙膏
黑人牙膏
注释跟好不好的命名没啥直接关联,注释多数是用来解释里面的方法有些需要特别注意的逻辑,参数的一些各种条件等,这些难道叫人家特意去看你的代码啊?不写好注释我个人觉得就是对自己队友不负责任的表现,也是自己懒惰的象征
yyyc
yyyc

引用来自“黑人牙膏”的评论

注释是魔鬼,我不认同,注释是团队合作里很重要的因素,按照此说法,jdk的源代码就是魔鬼了,觉得是胡说八道
原文的意思是不应该以注释去遮盖不易理解的部分(比如命名),而应该从代码本身来提高可读性。需要注释但不能依赖注释。
冰珊孤雪
冰珊孤雪
写得很好
子戮

引用来自“黑人牙膏”的评论

注释是魔鬼,我不认同,注释是团队合作里很重要的因素,按照此说法,jdk的源代码就是魔鬼了,觉得是胡说八道

引用来自“QuenTine”的评论

原文的意思是代码要写得让更精简的注释就能解释得清楚,让注释没有必要,而不是不要。
假如函数名称能用中文,我也宁愿不写注释.不过话说那样老外就看不懂了.所以,用老外的眼光来看待代码,本身就存在异议,不是每个人看到英文都能懂的,不是么?
阿凡兔
阿凡兔

引用来自“黑人牙膏”的评论

注释是魔鬼,我不认同,注释是团队合作里很重要的因素,按照此说法,jdk的源代码就是魔鬼了,觉得是胡说八道
赞同
第一班火车
第一班火车
对得起10分钟的阅读
n
nahuo
殊途同归吧
返回顶部
顶部