代码整洁之道

是的，我们就是一群代码猴子，上窜下跳，自以为领略了编程的真谛。可惜，当我们抓着几个酸桃子，得意洋洋的坐到树枝上，却对自己造成的混乱熟视无睹。那堆“可以运行”的乱麻程序，就在我们的眼皮底下慢慢腐坏。

这段话引用自Robert C.Martin（鲍勃大叔）所著的《代码整洁之道》。当时刚买来这本书时，只是随便翻了翻，觉得没什么意思就扔到一边去了。最近在书堆里又偶然发现了它，便又拿出来重新读了读。而这次就真的被它吸引了，一本书读下来，感觉自己受益匪浅。

现在想想经历这个过程也是有原因的吧，毕竟刚买这本书的时候，才接触Java编程没多久，根本没有写过多少代码，对于书中提到的种种规则自然难以理解。而现在自己有了一定的代码量，并且读了很多别人的代码之后，再来读这本书，便对书中所讲的种种“整洁代码”产生了深深的共鸣。

在我还是编程初学者的时候，就是还没有真正写过几行代码的时候，我从来没有想到过这些规则的重要性。可是近期，在和学校实验室中几名同学一起开发项目，还有和研究生的师兄一起做算法实验的时候，工程的代码数量渐渐多了起来。一段时间之后，那些代码便变得杂乱不堪，有各种不同风格的变量名、各种让人难以理解的魔术数字、还有到处混杂的被注释掉了的代码，以至我们几个小伙伴也惊异于这样的代码居然可以运行。正好寒假阶段我们便商量着重构之了。

书中谈到的一些“规则”，有些我也是深有体会，比如：不要注释掉代码，如果代码没用了，就删掉它。我经常在别人的代码中看到被注释了的代码，搞不懂是什么意思，想删掉又担心这代码还有什么特殊用途。这对强迫症来说简直就是折磨啊喵！！！还有函数应该小巧，只做并做好一件事。这样的函数模块与其他模块有较低的耦合并且容易理解，重用性也高。

下面就谈谈这本书对我的启发吧，对今后的软件开发也有很好的指导意义：

有关注释：

• 注释只应该描述有关代码和设计的技术性信息。
• 过时、无关、或不正确的注释是废弃的注释，应当及时修改或删除。
• 可以充分自我描述的代码不需要注释。
• 不要注释掉代码，看到被注释掉的代码就删除它。不用担心，版本控制工具会记得。

有关函数：

• 函数名应当能表明函数意图或行为。且应当明确，不应有歧义。
• 函数的参数量越少越好。
• 函数不应该有标识参数，比如以布尔值为参数。这意味着函数做了过多的事情。
• 永远不再使用的函数应该删除，否则会迷惑其他的代码阅读人员。况且有版本控制工具。

有关重复：

• 重复的代码意味着遗漏了抽象。
• 利用合理的设计模式，消除重复。

其他小细节：

• 变量和函数应该在靠近被使用的地方定义。
• 私有函数应该刚好在其首次被使用的位置下面定义。
• 不互相依赖的东西不应该耦合。比如不应该在特殊类中声明用于一般目的的static函数。
• 用命名常量代替魔术数字。

总之，整洁代码应当是令人愉悦的，而不应该让读者感到厌倦。而写出整洁的代码，的确需要大量的实际操练。在今后的编程中，应当努力遵循整洁代码的规范，在动手敲代码前，要多动脑思考代码的“设计”，写出整洁的代码。希望能和小伙伴们共同进步、共同提高。