62. 只有代码会告诉你真相

只有代码会告诉你真相

程序的终极语义由它的运行代码给出。如果它只有二进制的形式，那将非常难以阅读！然而，如果是你的程序、任何典型的商业软件开发、开源项目或者动态的解释型语言程序，都是有源代码的。看一下源代码，程序的意思就应该清楚明了了。要了解一个程序做了什么，源代码是你最终肯定应该看的。即便是最精确的需求文档也没有说明全部真相：它没有包含程序真正做什么的详细信息，只有需求分析中的高层意图。设计文档中可能会包含有计划性的设计，但是缺乏实现的必需细节。这些文档也可能与当前的实现不同步......或者可能已经弄丢了，或者一开始就没有写过。剩下的就只有源代码了。

头脑中有了这个观点，问一下你自己，你的代码有多清晰地向你或者其它程序员说明了它在做什么？

你可能会说，“噢，我的注释会告诉你需要知道的一切。”但是记住，注释不是运行代码，它们可能会像其它文档一样是错误的。有一种传统说注释无条件地是好的，因而无疑有些程序员写了越来越多的潘秋，即便是在复述和解释细微的已经很明显的代码。这不是让代码清晰的正确方法。如果你的代码需要注释，可以考虑通过重构让它不需要。冗长的注释可以弄乱你的屏幕空间，甚至可能会被IDE自动隐藏。如果你需要解释一项修改，在版本控制系统的提交信息中做，而不要放在源代码中。

怎么做才能真正让代码尽可能地说明真相呢？努力选择好的名字。结构化代码使功能更内聚，也让命名更轻松；解耦功能实现正交。编写自动化的测试来解释目的行为并检查接口。当知道如何编码一个更容易、更好的解决方案时，毫不犹豫地重构代码。让代码尽可能容易阅读和理解。

像任何其它作品，如诗歌、小品文、公开博客或者重要的电子邮件一样对待你的代码。仔细、精心地表达，它就会做它应该做的，并且尽可能直接地传达它正在做的，这样它就会在你不在旁边时也能传达你的目的。记住有用的代码往往比它计划的要使用更多的时间。负责维护的程序员会感谢你。同时，如果你是一个负责维护的程序员，而代码又不能清楚地告诉你其中的真相，积极主动地应用以上指导吧。在代码中建立理智，并保持自己明智。

原文：Only the Code Tells the Truth by

Peter Sommerlad