我突然想起來,很多程序員都討厭閱讀代碼。來吧,承認(rèn)吧! 每個(gè)人都喜歡編寫代碼,編代碼是件趣事。 另一方面,閱讀代碼也不容易。 不僅不容易(編注:參見《微軟資深軟件工程師:閱讀代碼不容易》),而且還非常枯燥,咱們要面對這一事實(shí)。任何不是你的代碼都不怎樣。(雖然我們沒有說出來,但我們都是這樣想的。)
即便是你自己幾個(gè)小時(shí)之前寫的代碼,也會看起來很爛。時(shí)間越久,看起來越爛。 所以,為什么你要浪費(fèi)時(shí)間去看其他人的糟糕代碼,而你完全可以利用這段時(shí)間編寫你自己的優(yōu)秀代碼。 其實(shí)我們可以一試,幾個(gè)小時(shí)之后回頭再看,看看你的代碼是否還依舊優(yōu)秀。 如果你不能吸收前輩大師的經(jīng)驗(yàn)知識,那你永遠(yuǎn)都無法成為一位大師。
成為大師的方法之一是,找到一位大師,讓其傾囊傳授其所知。 有這種可能么?當(dāng)然了,有這可能,雖然機(jī)會不大,但你必須極其走運(yùn)。 不過你不必十分走運(yùn),因?yàn)槲覀冃疫\(yùn)地處于這樣一個(gè)職業(yè),一個(gè)充滿著大師知識和技能的職業(yè),等待我們?nèi)ゼ橙∥眨@些東西就在他們所編寫的代碼中。 你要做的就是去閱讀代碼,當(dāng)然了,這或許耗時(shí)不少,畢竟沒有人坐在那里給你講解,但這種方法的成效還很高。 打個(gè)比方,要想成為一名卓越的木匠,得觀察大量結(jié)構(gòu)優(yōu)良的家具。
我喜愛閱讀代碼,我的直覺告訴我,你也會從中獲益頗豐。雖然閱讀過程惱人并煩人,但其回報(bào)是非常值得你為之努力的。 說到這個(gè),如果你想成為一名卓越的作家,你會專注于寫作么? 你或許已經(jīng)嘗試,但你并沒有走得很遠(yuǎn)。 大多數(shù)的偉大作家也是如饑似渴的讀者,這是一個(gè)普遍事實(shí)。 在你能寫出任何拿得出手的東西之前,你需要品讀其他偉大作家,吸收不同的風(fēng)格,看看前輩已嘗試過的東西,從中吸取精華。 你的知識會慢慢增長,你自己的作品最終會透露出些許成熟,你也會找到一種“感覺”。 編寫代碼和寫作沒什么不同,如果你都沒有閱讀過任何卓越的代碼,你為什么期望自己能寫出像樣的代碼呢? 你顯然不應(yīng)該那樣。對于程序員來說,閱讀卓越代碼就如同作家閱讀優(yōu)秀書籍一樣重要(這話可不是我說的,這是Peter Norvig(Google研究院總監(jiān))說的,他非常優(yōu)秀,大家也要向他學(xué)習(xí)了)。
即便所有這些都無法讓你信服,那這里有一個(gè)不可置否的事實(shí)。 對你作為一名專業(yè)開發(fā)人員的生存來說,善于閱讀代碼至關(guān)重要。 如今,任何有一定規(guī)模的項(xiàng)目,都是團(tuán)隊(duì)的成果。所以,你通常要處理、修改和擴(kuò)展大量不是你寫的代碼。 因此,閱讀代碼可能是你能掌握的最常用并最有用的技能。挺過這個(gè)難關(guān),好好掌握。
如何閱讀代碼?像某些人一樣……
我已經(jīng)記不清有多少次看到程序員(用鼠標(biāo))滾上滾下地看著不熟悉的代碼,幾分鐘過后,他們的臉上浮現(xiàn)出不悅的表情。 他們不久后會宣告說,那代碼不值一讀,為什么要浪費(fèi)時(shí)間呢?我們只能用其他方法解決問題。 我不確定(他們)在期待什么,是通過潛移默化來吸收代碼的含義,還是集中精神盯著代碼來得到啟發(fā)? 你不能只靠長時(shí)間盯著代碼來閱讀代碼,你要理解它并化為己用。 這里有一些我喜歡用的技巧,雖然這不是一份詳盡的列表,但我發(fā)現(xiàn)其中有些特別有用。
1.盡力構(gòu)建并運(yùn)行代碼。 這通常是一個(gè)簡單的步驟,就像你在看可運(yùn)行的代碼(這和隨機(jī)代碼相反)。 不過,并非總是如此。通過構(gòu)建和執(zhí)行代碼,你能從中學(xué)到很多上層代碼結(jié)構(gòu)。 說到工作代碼,你是否非常熟悉如何構(gòu)建你的當(dāng)前項(xiàng)目? 雖然構(gòu)建通常非常復(fù)雜,但通過構(gòu)建并生成可執(zhí)行的代碼,你能學(xué)到很多。
2. 不要只注重細(xì)節(jié)。 你要做的第一件事是,在你正閱讀的代碼中,找到代碼結(jié)構(gòu)和風(fēng)格的。 首先瀏覽一下代碼,盡力理解不同代碼段要做什么。這會讓你熟整個(gè)代碼的上層結(jié)構(gòu),你也能領(lǐng)會到你正處理的代碼的一些構(gòu)思(良好架構(gòu)和意大利面條等)。 這時(shí)候,你可以找到切入點(diǎn)(不管它是什么,主函數(shù)、servlet或控制器等),并查看代碼如何在那里分支。 不要在這上面花過多的時(shí)間,隨著你愈加熟悉代碼,你可以隨時(shí)回來查看。
3. 確信自己理解所有結(jié)構(gòu)。 除非你碰巧是所用編程語言的首席專家,否則該語言有些它能做的事你可能還不知道。當(dāng)你在瀏覽代碼時(shí),記下所有你或許不熟悉的結(jié)構(gòu)。 如果有很多不熟悉的結(jié)構(gòu),你要做的下一步非常明顯。 如果你不知道代碼要做什么,那你就走不了很遠(yuǎn)。 即便只有幾個(gè)你不熟悉的結(jié)構(gòu),你應(yīng)當(dāng)深入查看。 你現(xiàn)在是在探索你所用編程語言中你以前不知道的東西,為此花幾個(gè)小時(shí)來閱讀代碼,我也非常樂意。
4. 既然你對大多數(shù)結(jié)構(gòu)已有很好了解,那現(xiàn)在是該做些隨機(jī)深入研究了。 就像步驟2,開始瀏覽代碼,當(dāng)這次要挑選一些隨機(jī)函數(shù)或類,并開始逐行詳細(xì)查看。 這是硬仗開始的地方,但也是你要取得主要成功的地方。 這里的構(gòu)想,會形成你正在查看的代碼庫的思維模式。 也不要在這上面花過長的時(shí)間,但在繼續(xù)前行之前,你要盡力并極大吸收一些有內(nèi)容的代碼塊。 這個(gè)步驟,你也可以隨時(shí)反復(fù)回過頭來,每次你都會了解更多的背景,并收獲更多。
5. 毫無疑問,在前面這些步驟中,肯定有你困惑的地方,所以這是你做些測試的最佳時(shí)間。在測試的時(shí)候,你的麻煩可能會更少,同時(shí)你也能理解代碼。 我一直感到奇怪,開發(fā)人員忽略一套寫得很好很全面的測試代碼,而盡力去閱讀并理解某些代碼。 當(dāng)然了,有時(shí)候并沒有測試。
6. 如果你說沒有測試,那這聽起來是編寫測試的時(shí)候了。 (編寫測試)有很多益處,有助于你自己的理解,有助于你提升代碼庫,閱讀代碼時(shí)也能編寫代碼,這是該你出手做些事的時(shí)候。 即便已經(jīng)有了測試,通常你也可以編寫一些測試,你總能受益的。 測試代碼通常需要換種方式思考問題,那些你以前不太明了的概念也會變得更清晰。
7. 提取奇特的代碼,使其成為單獨(dú)的程序。我發(fā)現(xiàn)閱讀代碼是個(gè)非常有趣的練習(xí),即便只為節(jié)奏變化。 即便你不了解代碼的底層細(xì)節(jié),你或許能知道一些代碼在上層結(jié)構(gòu)上要做什么。 什么不提取一些特定的函數(shù),單獨(dú)列為獨(dú)立的程序。 當(dāng)你在執(zhí)行小段程序時(shí),調(diào)試也會更簡單。反過來說,可能還需要一些額外的步驟,才能理解你正查看的代碼。
8. 代碼不干凈?有異味? 為什么不重構(gòu)它? 我并不建議你重寫整個(gè)代碼庫,但重構(gòu)部分代碼,真的有助于你理解層次上升一層。 把你理解的函數(shù)拿出來,改成獨(dú)立的函數(shù)。 在你知道之前,原來的大函數(shù)看起來易管理,你可以在腦海中修改它。 重構(gòu)允許你把代碼變成自己的,無需完成重寫代碼。 如果有好的測試,有助于重構(gòu),但即便你沒有好的測試,抽取你確定的函數(shù)并做測試。 即便測試看起來完全不充分,但作為一個(gè)開發(fā)人員,你得學(xué)著相信你的技能,有時(shí)候你只需努力去做(重構(gòu))。(如果你必須重構(gòu),你通常都可以把代碼恢復(fù)原狀。)
9. 如果沒什么能幫上忙,那你就找個(gè)閱讀代碼的同伴。或許并非只有你一個(gè)人能從這代碼中獲益,所以去找一個(gè)人,一起閱讀代碼吧。 但你別找專家,他們會從上層結(jié)構(gòu)上,向你解釋所有東西,你會錯(cuò)失那些你自己詳細(xì)查看代碼時(shí)所能學(xué)到的細(xì)微差別。 然而,如果不見效的話,你也不能理解,有時(shí)候,你能做的最好的事就是去問。 向你的同事請教,如果你正在閱讀開源代碼,可以在互聯(lián)網(wǎng)上找人問問。 但是你要記住,這是最后一步,而不是第一步。
如果我時(shí)間緊迫,需要快速合理地理解某些代碼,并且我只能挑選上述步驟的其中一個(gè),那我會選擇“重構(gòu)”(即:第8個(gè)步驟)。 雖然你能理解的東西不會很多,但那些你領(lǐng)會的東西,你會牢牢記住的。 總之,有件事你需要記在心里。 如果你新接觸一個(gè)重要的代碼庫,你不可能立即能理解它。 這需要數(shù)天、數(shù)周和數(shù)月的潛心努力,接受這個(gè)事實(shí)。 即便有一位專家和你在一起,也不能明顯地縮短時(shí)間(。 然而,當(dāng)涉及到代碼庫時(shí),如果你能耐心并有條不紊地閱讀(和編寫)代碼,你最終能熟悉項(xiàng)目的方方面面,你能成為大牛。 你或者是逃避閱讀代碼,經(jīng)常尋求某人幫你講解某事。 我知道我會成為哪一種人。
尋找閱讀代碼的機(jī)遇 – 不要錯(cuò)失
我們喜歡編寫新代碼,是因?yàn)槲覀冞@次能正確處理問題。 好吧,也許不是這次,但一定是下次。 事實(shí)上是,你經(jīng)常改進(jìn)你的技術(shù),但你從沒有恰當(dāng)?shù)靥幚韱栴}。 這就是編寫新代碼的價(jià)值所在,你可以歷練并磨練你的技能,但閱讀和把玩其他人編寫的代碼,(如果沒有更多的價(jià)值,)也是有同樣多的價(jià)值。 你不僅能從中獲得一些有價(jià)值的技術(shù)知識,也能收獲領(lǐng)域知識,領(lǐng)域知識通常仍具更多價(jià)值(畢竟,代碼是文檔的最終形式)。
即便代碼寫得很神秘,無任何慣例可言,但還是有價(jià)值。 你知道我在說的代碼,它幾乎看起來晦澀難懂,但不是有意而為之(因某些原因,Perl語言代碼通常是這樣的)。 不管什么時(shí)候我看到那樣的代碼,我都會這樣想: 把它想象成只有你破譯它后才能學(xué)到的東西。 是的,這是主要的痛楚之處,但要接受它,有時(shí)候你自己也會因瑣碎的原因而寫出那種使人困惑的代碼(否認(rèn)沒有用,你知道這是真的)。 好了,如果你花些時(shí)間來閱讀那樣的代碼,你更有可能最終寫出同樣的代碼。并不說你將會寫出那樣的代碼,但你有能力寫出那樣的代碼。 最后,態(tài)度通常是最重要的(編注:態(tài)度決定一切)。 如果你視閱讀代碼為日常繁瑣的工作,那它就是(繁瑣的工作),并且你會逃避,但如果你視其為一個(gè)機(jī)遇,那好事終將到來。
-
程序員
+關(guān)注
關(guān)注
4文章
952瀏覽量
29818
發(fā)布評論請先 登錄
相關(guān)推薦
評論