閱讀代碼要像閱讀猶太法典

導(dǎo)讀：軟件開發(fā)者 Alan Skorkin 寫過一篇文章，講述他為什么喜歡閱讀他人代碼，并建議其他同行也如此。因?yàn)殚喿x優(yōu)秀代碼是提高開發(fā)人員修為的一種捷徑。微軟的資深軟件工程師 Eric Lippert 在答復(fù)同行JeremyK 的問題時也感嘆閱讀代碼很難。

Seth Gordon 給 Joel Spolsky 發(fā)過一封電子郵件，分享了有關(guān)閱讀他人源碼的一些不錯建議。以下是郵件的譯文：

在以色列的神學(xué)院學(xué)習(xí)8個月后，我開始在波士頓當(dāng)一名技術(shù)作家。

一年多前，我和一位同事正試圖解釋一個Yacc和Perl的怪題，我們打印了部分文檔。我們坐下來看代碼并逐行討論，“現(xiàn)在，由于Yacc的工作方式，當(dāng)遇到*this*這樣的數(shù)據(jù)時，它就將運(yùn)行*this*函數(shù)…… *this* 這一行是做什么的？就*this*這一點(diǎn)，這個混亂的數(shù)據(jù)結(jié)構(gòu)看起來像什么？”

另一位同事問事情進(jìn)展如何，我告訴他，“這就像在閱讀猶太法典（Talmud）�！�

下面就是猶太法典的閱讀戰(zhàn)術(shù)，我認(rèn)為同樣適用于閱讀代碼：

1. 兩人結(jié)對進(jìn)行，相互逐行逐句讀代碼。（編注：應(yīng)該輪流解釋代碼。）

2. 討論。如果你的搭檔說“這個是X的意思”，當(dāng)你并不理解或者你有其他看法時，請他作出解釋。

3. 有時候，當(dāng)處理一段代碼時，很容易找出你能看懂的部分。所以，如果有段代碼難住你了，可嘗試跳過，稍后返回再看。（最終還是要回到該處的）

4. 閱讀代碼，既要“從內(nèi)看”，也要“從外看”�！皬膬�(nèi)看”就是一個字一個字地把原文解釋成英文（或你的母語）；“從外看”就是把一段代碼詮釋成通順的段落。如果只“從內(nèi)看”，你會只見樹木不見森林；如果只“從外看”，你會只有個寬泛的猜測，無法核實(shí)細(xì)節(jié)。

結(jié)語

文章開頭提到的JeremyK ，他對閱讀不熟悉代碼的看法是，自己重寫。 關(guān)于閱讀代碼，如果你有其他建議，歡迎在評論中分享。

Joel Spolsky是一名美國軟件工程師，他的網(wǎng)絡(luò)日志“Joel談軟件（Joel on Software）”非常有名，讀者人數(shù)可以排進(jìn)全世界前100名。

英文原文：http://www.joelonsoftware.com/articles/fog0000000053.html