13. 代码布局很重要

代码布局很重要

        多年以前，我在一个Cobol系统中工作，里面员工不允许改变代码的缩进，除非他们有确定的理由，因为曾经某人在某行缩进了几列，结果就把什么东西弄坏了。即使是在布局会误导人的情况下，也必须这样，于是我们不得不非常小心地阅读代码，因为我们不相信它。这个政策给程序员很大的负担，并为之花了不少钱。
        有研究显示，我们都在编程的时间中，花在浏览和查看代码的时间，寻找哪里可以改变，比真正键入的时间要多。因此，这就是我们需要优化的。
        容易扫描。人们都很善于视觉模式匹配（这是我们从需要在热带大草原上发现狮子的时代遗留下来的），所以我可以通过标准化让所有与领域没有直接关联的东西，所有的在商业语言中出现的“偶然复杂性”，褪色成背景。如果看起来相同的代码表现一样，我的视觉系统可以帮助找出其中的不同。因此我也遵守如何通过编译单元布局类的各部分的惯例，常量、字段、公开方法和私有方法。
        富有表现性的布局。我们都学习过花时间找到正确的名字，以使我们的代码尽可能清楚地表达它是做什么的，而不是列出步骤——对吧？代码布局也是表现性的一部分。首先要团队同意对基础语法使用自动格式化工具，接下来我可能会在写代码时手动作一些调整。除非团队成员之间存在矛盾，否则很快就会得到一个公共的“手工完成”的风格。一个格式化工具不能理解我的意图（我应该知道，曾经写过一个），对我更重要的是，换行和分组的行反映的是代码的意图，而不仅是所用语言的语法。（Kevin McGuire把我从自动代码格式化工具的奴役中解放了出来）。
        紧凑格式。在一个屏幕上能得到的东西越多，我就能在不滚动或者切换文件的情况下，看到更多的东西，这意味不着我在大脑中只需要保持更少的状态。漫长过程的注释和大量的空白，对8字节名称和行式打印机可能说得通，但现在我是活在语法高亮和交叉链接的IDE中。像素是我的限制因素，所以我要每个人所做的都有肋于我理解代码。我要的是布局帮助我理解代码，而不是其它的什么。
        一个不是程序员的朋友有次说代码就像是诗歌。我也从真正优秀的代码中得到了这种感觉，字里行间都透露着意图，正是这些帮助我理解其思想。不幸的是，写代码没有像写诗歌一样的浪漫形象。

原文：Code Layout Matters by Steve Freeman