那就是去讀別人寫的代碼握童。讀那些你常用的庫、編程框架的源代碼叛赚,讀那些你景仰的大牛的源代碼澡绩,讀代碼里的測試(測試本身就是一種有效的文檔);讀代碼俺附、改代碼肥卡、運(yùn)行代碼。
其實(shí)事镣,所謂寫程序步鉴,大部分的時(shí)間都是花在讀代碼上,“寫”的部分耗時(shí)極少蛮浑;所以把“讀”的技能訓(xùn)練好了唠叛,是很有好處的。
提高編程能力萬無一失的辦法
編注:這篇文章最初于 2010 年 5 月為 Fuel Your Coding 網(wǎng)站而寫沮稚。不幸的是艺沼,那個(gè)網(wǎng)站已經(jīng)不復(fù)存在了,所以我將這篇文章重新發(fā)布蕴掏。為了緊跟時(shí)代步伐障般,我想過對其進(jìn)行更新调鲸,但我又覺得這篇文章經(jīng)得起時(shí)間考驗(yàn)。經(jīng)不起時(shí)間考驗(yàn)的內(nèi)容是有些可笑的挽荡,不管怎樣藐石,盡情享受吧。
——-
每個(gè)人都知道定拟,提高編程能力的顯著方法是寫更多代碼于微。然而,我保證能夠提高編程能力的另一種方法卻不是寫代碼青自。我會(huì)盡我所能說明這一點(diǎn):
如果你想大幅提高自己的編程能力株依,你需要閱讀別人的代碼。
不管你以前是不是這樣想的延窜,現(xiàn)在你應(yīng)該接受這個(gè)觀點(diǎn)恋腕。如果你愿意嘗試一下,那么你將會(huì)收獲頗豐逆瑞。
在這篇文章中荠藤,我會(huì)幫助你選擇閱讀哪些代碼并且給出如何閱讀代碼的實(shí)用建議。如果你已經(jīng)是一個(gè)代碼閱讀者获高,你可能已經(jīng)找到了一些有效的方法哈肖,否則,我覺得你應(yīng)該開始閱讀代碼念秧。
閱讀哪些代碼
這是一個(gè)重大的決定牡彻,也是一個(gè)很難提出建議的決定。由于閱讀什么代碼歸根結(jié)底與你的工作有關(guān)出爹,所以我不會(huì)簡單的指出我認(rèn)為你應(yīng)該讀的具體代碼。然而缎除,我將會(huì)提供給你一些閱讀代碼的參考严就。
閱讀你依賴的代碼
閱讀使用的插件或庫是一個(gè)很好的開始。
一個(gè)你真正喜歡的 WordPress 插件
一個(gè)你發(fā)現(xiàn)有用的 Ruby gem
一個(gè)你一直使用的 jQuery 插件
這些都是很好的選擇器罐。你已經(jīng)很熟悉它們的公共 API梢为,這樣會(huì)降低對內(nèi)部工作機(jī)制的理解障礙。此外轰坊,作為代碼的使用者铸董,你有機(jī)會(huì)添加文檔、實(shí)現(xiàn)新功能或以某種方式為項(xiàng)目貢獻(xiàn)代碼肴沫。
閱讀令你印象深刻的代碼
我記得第一次看到 280 Slides 的情景粟害,當(dāng)時(shí)我告訴自己“這真的令人印象深刻”。我很快了解到它是一個(gè)由開源 Cappuccino 項(xiàng)目框架開發(fā)的網(wǎng)站颤芬,我將它牢記于心悲幅,當(dāng)我再次遇到一個(gè)令人印象深刻的 app 也使用 Cappuccino 框架時(shí)套鹅,我知道我可以從這個(gè)項(xiàng)目中學(xué)到很多。最近令你印象深刻的是什么汰具?它是開源代碼嗎卓鹿?如果是,那么它將是一個(gè)很好的選擇留荔,因?yàn)榇a可能會(huì)與應(yīng)用一樣令你印象深刻吟孙。
閱讀你崇拜的人寫的代碼
如果你已經(jīng)使用開源軟件寫了一段時(shí)間代碼,你可能會(huì)有一些崇拜的程序員聚蝶。我能想到幾個(gè)令人羨慕的代碼開發(fā)者杰妓。
如果你沒有一個(gè)崇拜的開發(fā)者,你也可以很容易地找到一個(gè)既荚。她/他很可能寫了前面兩段提到的代碼(你依賴的代碼稚失、令你印象深刻的代碼)。
閱讀你可以理解的代碼
如果你喜歡冒險(xiǎn)恰聘,你可能會(huì)考慮深入理解一個(gè)大型項(xiàng)目句各,如 Ruby on Rails、Drupal晴叨、或者 jQuery凿宾。我建議你目前避開這樣的項(xiàng)目,除非你是一個(gè)有經(jīng)驗(yàn)的代碼閱讀者兼蕊。
大項(xiàng)目包括更多模塊初厚,你可能掙扎于紛雜的概念,而沒有學(xué)到有價(jià)值的內(nèi)容孙技。困惑會(huì)使人沮喪产禾,項(xiàng)目越大,越容易產(chǎn)生困惑牵啦,從而影響你的閱讀亚情。閱讀小項(xiàng)目的好處就是你可以很快的了解整個(gè)程序的邏輯,這樣你就更容易集中精力發(fā)現(xiàn)和學(xué)習(xí)其中的細(xì)節(jié)哈雏。
如何閱讀
現(xiàn)在你已經(jīng)選擇了要讀的代碼楞件,那么閱讀代碼的最佳方式是什么呢?
我已經(jīng)讀過很多的代碼裳瘪,我可以給出一些最大限度提高投資回報(bào)率的閱讀方法土浸。
縱觀全局
我認(rèn)為你至少要在宏觀層面了解你所讀的代碼。如果不了解彭羹,建議你閱讀項(xiàng)目網(wǎng)站黄伊、教程、文檔或者其它除代碼以外的任何資料派殷。
好了毅舆,從宏觀層面了解代碼后西篓,我建議你第一步先了解項(xiàng)目的結(jié)構(gòu)。這項(xiàng)工作的工作量取決于你所選擇代碼的規(guī)模憋活,任何多于一個(gè)文件的項(xiàng)目都需要花一點(diǎn)時(shí)間岂津。
首先注意文件結(jié)構(gòu)。這一步可以使用一個(gè)有文件夾層次結(jié)構(gòu)視圖的編輯器(如 TextMate)悦即,比如吮成,這是一個(gè)很好的Twitter Ruby gem 總覽。
這一步的目標(biāo)是熟悉源代碼辜梳。找出哪些文件包含/需要/加載其它文件粱甫,大部分代碼在哪,使用的命名空間是什么以及這類性質(zhì)的內(nèi)容作瞄。一旦了解了全局茶宵,你就可以準(zhǔn)備深入挖掘細(xì)節(jié)了。
記錄你的發(fā)現(xiàn)
閱讀代碼不應(yīng)該是個(gè)被動(dòng)行為宗挥。我鼓勵(lì)你添加注釋乌庶,當(dāng)開始了解程序流程時(shí)記錄你的假設(shè)和結(jié)論。當(dāng)你第一次開始寫評論時(shí)看起來是這樣的:
# I think this function is called after 'initialize'
# 我認(rèn)為這個(gè)函數(shù)在“初始化”之后調(diào)用
# What does this equation even do?
# 這個(gè)公式是做什么用的契耿?
# Pretty sure this variable loses scope after line 17
# 非常確定這個(gè)變量在 17 行后失去作用域
隨著你的深入理解瞒大,你可以刪除自己的用戶評論,寫出可以反饋給項(xiàng)目的更有意義搪桂、更權(quán)威的評論透敌。
使用測試,Luke(用于方便開發(fā)和診斷的第三方工具)
希望你選擇的項(xiàng)目有測試套件踢械。如果沒有酗电,你完全可以跳過這一節(jié)(或者找一個(gè)有的)。
當(dāng)你閱讀別人的代碼時(shí)内列,測試是一個(gè)很好的開始顾瞻,因?yàn)樗鼈冇涗浟舜a應(yīng)該實(shí)現(xiàn)的功能。有些測試比其他信息更豐富德绿,但是不管寫的多好,你經(jīng)常會(huì)發(fā)現(xiàn)使用測試比執(zhí)行代碼更容易了解程序員的意圖退渗。當(dāng)你閱讀時(shí)移稳,試著讓測試套件成功運(yùn)行。這將確保你的開發(fā)環(huán)境配置正確会油,并將使你在進(jìn)行更改時(shí)更加自信个粱。
執(zhí)行,改變內(nèi)容翻翩,執(zhí)行
誰說讀代碼就不需要?jiǎng)邮侄夹恚恳坏┠愦蚱埔磺性賹⑺鼈冎匦抡显谝黄鸬巨保悴砰_始真正明白。還記得你做過的那些測試嗎胶征?使測試失敗塞椎,添加一些新功能,或者嘗試在不破壞的情況下改變執(zhí)行睛低。嘗試著添加一些你覺得很酷的小功能案狠,或者設(shè)置項(xiàng)目范圍的日志記錄,這樣可以在代碼各個(gè)階段打印輸出钱雷。這還是閱讀嗎骂铁?當(dāng)然,此時(shí)更像是自己在冒險(xiǎn)罩抗,而不是看一本偵探小說拉庵。這是一件好事。
沖洗和重復(fù)
當(dāng)你讀完一個(gè)代碼庫套蒂,選擇另外一個(gè)代碼庫重新開始這個(gè)過程钞支。你讀的代碼越多、讀的越好泣懊,完成的時(shí)間就越短伸辟。我想你會(huì)發(fā)現(xiàn)投資回報(bào)率在飛快的增長,這實(shí)際上是一種非常愉快的學(xué)習(xí)方式馍刮。
從哪兒開始
對我閱讀代碼影響最大的是 GitHub信夫。在這個(gè)網(wǎng)站上,我們可以很容易的找到新項(xiàng)目和偉大的程序員卡啰,如果不好好利用它那將是在為自己幫倒忙静稻。我建議先在 GitHub 網(wǎng)站上閱讀代碼直到找到自己可以借鑒的項(xiàng)目,然后用 git clone 復(fù)制這個(gè)項(xiàng)目并開始閱讀匈辱!