那就是去讀別人寫的代碼。讀那些你常用的庫、編程框架的源代碼,讀那些你景仰的大牛的源代碼,讀代碼里的測試(測試本身就是一種有效的文檔);讀代碼、改代碼、運行代碼。
其實,所謂寫程序,大部分的時間都是花在讀代碼上,“寫”的部分耗時極少;所以把“讀”的技能訓練好了,是很有好處的。
提高編程能力萬無一失的辦法
編注:這篇文章最初于 2010 年 5 月為 Fuel Your Coding 網(wǎng)站而寫。不幸的是,那個網(wǎng)站已經(jīng)不復存在了,所以我將這篇文章重新發(fā)布。為了緊跟時代步伐,我想過對其進行更新,但我又覺得這篇文章經(jīng)得起時間考驗。經(jīng)不起時間考驗的內(nèi)容是有些可笑的,不管怎樣,盡情享受吧。
——-
每個人都知道,提高編程能力的顯著方法是寫更多代碼。然而,我保證能夠提高編程能力的另一種方法卻不是寫代碼。我會盡我所能說明這一點:
如果你想大幅提高自己的編程能力,你需要閱讀別人的代碼。
不管你以前是不是這樣想的,現(xiàn)在你應該接受這個觀點。如果你愿意嘗試一下,那么你將會收獲頗豐。
在這篇文章中,我會幫助你選擇閱讀哪些代碼并且給出如何閱讀代碼的實用建議。如果你已經(jīng)是一個代碼閱讀者,你可能已經(jīng)找到了一些有效的方法,否則,我覺得你應該開始閱讀代碼。
閱讀哪些代碼
這是一個重大的決定,也是一個很難提出建議的決定。由于閱讀什么代碼歸根結(jié)底與你的工作有關(guān),所以我不會簡單的指出我認為你應該讀的具體代碼。然而,我將會提供給你一些閱讀代碼的參考。
閱讀你依賴的代碼
閱讀使用的插件或庫是一個很好的開始。
一個你真正喜歡的 WordPress 插件
一個你發(fā)現(xiàn)有用的 Ruby gem
一個你一直使用的 jQuery 插件
這些都是很好的選擇。你已經(jīng)很熟悉它們的公共 API,這樣會降低對內(nèi)部工作機制的理解障礙。此外,作為代碼的使用者,你有機會添加文檔、實現(xiàn)新功能或以某種方式為項目貢獻代碼。
閱讀令你印象深刻的代碼
我記得第一次看到 280 Slides 的情景,當時我告訴自己“這真的令人印象深刻”。我很快了解到它是一個由開源 Cappuccino 項目框架開發(fā)的網(wǎng)站,我將它牢記于心,當我再次遇到一個令人印象深刻的 app 也使用 Cappuccino 框架時,我知道我可以從這個項目中學到很多。最近令你印象深刻的是什么?它是開源代碼嗎?如果是,那么它將是一個很好的選擇,因為代碼可能會與應用一樣令你印象深刻。
閱讀你崇拜的人寫的代碼
如果你已經(jīng)使用開源軟件寫了一段時間代碼,你可能會有一些崇拜的程序員。我能想到幾個令人羨慕的代碼開發(fā)者。
如果你沒有一個崇拜的開發(fā)者,你也可以很容易地找到一個。她/他很可能寫了前面兩段提到的代碼(你依賴的代碼、令你印象深刻的代碼)。
閱讀你可以理解的代碼
如果你喜歡冒險,你可能會考慮深入理解一個大型項目,如 Ruby on Rails、Drupal、或者 jQuery。我建議你目前避開這樣的項目,除非你是一個有經(jīng)驗的代碼閱讀者。
大項目包括更多模塊,你可能掙扎于紛雜的概念,而沒有學到有價值的內(nèi)容。困惑會使人沮喪,項目越大,越容易產(chǎn)生困惑,從而影響你的閱讀。閱讀小項目的好處就是你可以很快的了解整個程序的邏輯,這樣你就更容易集中精力發(fā)現(xiàn)和學習其中的細節(jié)。
如何閱讀
現(xiàn)在你已經(jīng)選擇了要讀的代碼,那么閱讀代碼的最佳方式是什么呢?
我已經(jīng)讀過很多的代碼,我可以給出一些最大限度提高投資回報率的閱讀方法。
縱觀全局
我認為你至少要在宏觀層面了解你所讀的代碼。如果不了解,建議你閱讀項目網(wǎng)站、教程、文檔或者其它除代碼以外的任何資料。
好了,從宏觀層面了解代碼后,我建議你第一步先了解項目的結(jié)構(gòu)。這項工作的工作量取決于你所選擇代碼的規(guī)模,任何多于一個文件的項目都需要花一點時間。
首先注意文件結(jié)構(gòu)。這一步可以使用一個有文件夾層次結(jié)構(gòu)視圖的編輯器(如 TextMate),比如,這是一個很好的Twitter Ruby gem 總覽。
這一步的目標是熟悉源代碼。找出哪些文件包含/需要/加載其它文件,大部分代碼在哪,使用的命名空間是什么以及這類性質(zhì)的內(nèi)容。一旦了解了全局,你就可以準備深入挖掘細節(jié)了。
記錄你的發(fā)現(xiàn)
閱讀代碼不應該是一個被動行為。我鼓勵你添加注釋,當開始了解程序流程時記錄你的假設(shè)和結(jié)論。當你第一次開始寫評論時看起來是這樣的:
隨著你的深入理解,你可以刪除自己的用戶評論,寫出可以反饋給項目的更有意義、更權(quán)威的評論。
使用測試,Luke(用于方便開發(fā)和診斷的第三方工具)
希望你選擇的項目有測試套件。如果沒有,你完全可以跳過這一節(jié)(或者找一個有的)。
當你閱讀別人的代碼時,測試是一個很好的開始,因為它們記錄了代碼應該實現(xiàn)的功能。有些測試比其他信息更豐富,但是不管寫的多好,你經(jīng)常會發(fā)現(xiàn)使用測試比執(zhí)行代碼更容易了解程序員的意圖。當你閱讀時,試著讓測試套件成功運行。這將確保你的開發(fā)環(huán)境配置正確,并將使你在進行更改時更加自信。
執(zhí)行,改變內(nèi)容,執(zhí)行
誰說讀代碼就不需要動手?一旦你打破一切再將它們重新整合在一起,你才開始真正明白。還記得你做過的那些測試嗎?使測試失敗,添加一些新功能,或者嘗試在不破壞的情況下改變執(zhí)行。嘗試著添加一些你覺得很酷的小功能,或者設(shè)置項目范圍的日志記錄,這樣可以在代碼各個階段打印輸出。這還是閱讀嗎?當然,此時更像是自己在冒險,而不是看一本偵探小說。這是一件好事。
沖洗和重復
當你讀完一個代碼庫,選擇另外一個代碼庫重新開始這個過程。你讀的代碼越多、讀的越好,完成的時間就越短。我想你會發(fā)現(xiàn)投資回報率在飛快的增長,這實際上是一種非常愉快的學習方式。
從哪兒開始
對我閱讀代碼影響最大的是 GitHub。在這個網(wǎng)站上,我們可以很容易的找到新項目和偉大的程序員,如果不好好利用它那將是在為自己幫倒忙。我建議先在 GitHub 網(wǎng)站上閱讀代碼直到找到自己可以借鑒的項目,然后用 git clone 復制這個項目并開始閱讀!