如何熟悉一個開源項目?

dwng 9年前發布 | 7K 次閱讀 開源項目

如何熟悉一個開源項目?

你有個任務,需要用到某個開源項目;或者老大交代你一個事情,讓你去了解某個東西。怎么下手呢?如何開始呢?我的習慣是這樣:

1、首先,查找和閱讀該項目的博客和資料,通過google你能找到某個項目大體介紹的博客,快速閱讀一下就能對項目的目的、功能、基本使用有個大概的了解。

2、閱讀項目的文檔,重點關注類似Getting started、Example之類的文檔,從中學習如何下載、安裝、甚至基本使用該項目所需要的知識。

3、如果該項目有提供現成的example工程,首先嘗試按照開始文檔的介紹運行example,如果運行順利,那么恭喜你順利開了個好頭;如果遇 到問題,首先嘗試在項目的FAQ等文檔里查找答案,再次,可以將問題(例如異常信息)當成關鍵詞去搜索,查找相關的解決辦法,你遇到了,別人一般也會遇 到,熱心的朋友會記錄下解決的過程;最后,可以將問題提交到項目的郵件列表,請大家幫你看看。在沒有成功運行example之前,不要嘗試修改 example。

4、運行了第一個example之后,嘗試根據你的理解和需要修改example,測試高級功能等。

5、在了解基本使用后,需要開始深入的了解該項目。例如項目的配置管理、高級功能以及最佳實踐。通常一個運作良好的項目會提供一份從淺到深的用戶指 南,你并不需要從頭到尾閱讀這份指南,根據時間和興趣,特別是你自己任務的需要,重點閱讀部分章節并做筆記(推薦evernote)。

6、如果時間允許,嘗試從源碼構建該項目。通常開源項目都會提供一份構建指南,指導你如何搭建一個用于開發、調試和構建的環境。嘗試構建一個版本。

7、如果時間允許并且有興趣,可以嘗試閱讀源碼:

(1)閱讀源碼之前,查看該項目是否提供架構和設計文檔,閱讀這些文檔可以了解該項目的大體設計和結構,讀源碼的時候不會無從下手。

(2)閱讀源碼之前,一定要能構建并運行該項目,有個直觀感受。

(3)閱讀源碼的第一步是抓主干,嘗試理清一次正常運行的代碼調用路徑,這可以通過debug來觀察運行時的變量和行為。修改源碼加入日志和打印可以幫助你更好的理解源碼。

(4)適當畫圖來幫助你理解源碼,在理清主干后,可以將整個流程畫成一張流程圖或者標準的UML圖,幫助記憶和下一步的閱讀。

(5)挑選感興趣的“枝干”代碼來閱讀,比如你對網絡通訊感興趣,就閱讀網絡層的代碼,深入到實現細節,如它用了什么庫,采用了什么設計模式,為什么這樣做等。如果可以,debug細節代碼。

(6)閱讀源碼的時候,重視單元測試,嘗試去運行單元測試,基本上一個好的單元測試會將該代碼的功能和邊界描述清楚。

(7)在熟悉源碼后,發現有可以改進的地方,有精力、有意愿可以向該項目的開發者提出改進的意見或者issue,甚至幫他修復和實現,參與該項目的發展。

8、通常在閱讀文檔和源碼之后,你能對該項目有比較深入的了解了,但是該項目所在領域,你可能還想搜索相關的項目和資料,看看有沒有其他的更好的項目或者解決方案。在廣度和深度之間權衡。

以上是我個人的一些習慣,我自己也并沒有完全按照這個來,但是按照這個順序,基本上能讓你比較高效地學習和使用某個開源項目。

來源: http://www.blogjava.net/killme2008/archive/2012/05/22/378885.html
 本文由用戶 dwng 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!