软件随想录(local.joelonsoftware.com/wiki)-2000年05月26日 读程序代码就像读犹太法典 - Reading Code is Like Reading the Tal

From The Joel on Software Translation Project

Reading Code is Like Reading the Talmud

作者：周思博 (Joel Spolsky)
译：Warlocky
Friday, May 26, 2000
属于Joel on Software, http://www.joelonsoftware.com

Seth Gordon 寄给我一些很棒的关于阅读他人程序代码时的建议：

在一家以色列的犹太教学院念了大约八个月的书后，我第一份工作是在波士顿担任技术文件写作人员。

大约一年前，我和另一位同事试著读懂一支用 yacc 及 Perl 写的丑陋程序，它的目的是用来产生我们的一些文件。把整份程序印出来之后，我们坐下来几乎是一行一行地检视。「由于 yacc 的原理是这样，所以它碰到*这种*资料会执行*这个*函数 ... *这行*是干什么用的？ ... 在*这个地方*这一沱资料看起来像什么？...」

别的同事问我是怎么做到的，我就告诉他：「这就像读犹太法典一样。」

以下这些阅读犹太法典的技巧我想对阅读程序也会有帮助：

1. 成对进行，并将想法大声念给对方听。
2. 讨论。若你的伙伴说「这个代表 X」但你却不了解个中原因或有不同意见时，请他说明原因。
3. 在阅读程序时，有时候先读完前后的程序*之后*，中间的部份会较容易了解。若你读到一段程序卡住时，先试著跳过去，之后再看看能不能重读一遍（但你最终还是得回来）。
4. 程序的內部运作及外部用法都要理解。了解內部运作时，应将一段一段的程序翻译成中文（或是你自己的母语）；观察外部用法时，应将一大段程序转换成直觉的概念。若只看內部运作，难免见树不见林；若只看外部用法，却又难免流于猜测而未佐以具体的细节。