讓你輕鬆學習新程式碼庫的六個步驟

csdn發表於2013-06-14

  學習新的程式碼庫是一項艱鉅的任務。如果你不能和建立該庫的研發人員進行交流,自己研究該庫是一個很複雜的過程。本文給出六個步驟指引開發者學習。

讓你輕鬆學習新程式碼庫的六個步驟

  步驟如下:

  步驟一:建立業務詞彙表單

  如果你是一位開發者,你或許會出席過一些軟體設計會議,會議可能會涉及到建立新術語,以便於更好的軟體設計交流。在建立該術語的同時可能會發生與該術語同義的情況,會議成員不可避免地討論這些具有相同概念的術語,這會讓人感到混亂。

  這時,業務詞彙表單就變得尤為重要,它能記錄這些新的術語。在軟體設計的每個階段,你會不斷碰到新的術語和概念。把這些術語儲存起來非常重要,並且邊學邊儲存,絕對有益無害。

  業務詞彙表單應該包含幾個不同的列,分別是:“術語名稱”、“語境”、“定義”。當你看到一個有趣的術語和短語時,可以更新該表單。該表單有可能包含大量的同義詞,也有可能有對同一術語的不同定義解釋。出現上述的情況,你需要結合上下文的語境進行分析使用。

  步驟二:瞭解應用程式

  執行應用程式並且獲知該程式提供的功能。如果你不知道該程式是做什麼的,就無法在原始碼中尋找有關資訊。

  步驟三:瀏覽有效的類庫文件

  迄今為止,是不是任何的體系結構或設計類庫文件的內容都是合理呢?這有待考量。類庫文件是一個極好的資源。如果舊的體系架構已經歷了數次修訂,它就不再值得你花時間去閱讀整個文件,不過,你可以大概瀏覽一下。如果你足夠幸運,你可以在文件中遇到你所需的術語。

  步驟四:做假設

  幾乎所有的應用程式中,開發者都會碰到如下情況:環境的配置、I18N(語言的國際化)、應用程式的檔案格式、使用者介面、應用程式的啟動和關閉。針對這些情況,可以進行假設。開發者可以假設應用程式中的任何一段程式碼塊,哪個程式碼塊是應用程式的核心,這個才是學習的重點。

  步驟五:定位第三方庫檔案

  程式碼庫很有可能存在一些的依賴。如果檢查到專案中包含第三方庫檔案,可以檢視該庫檔案是如何與應用程式的功能聯絡起來的,某處的模組或元件是如何使用第三方庫的。

  步驟六:分析程式碼

  本部分列舉幾個選項來分析新的程式碼庫:

  1、目錄以及檔案架構

  可以把目錄名中的一些術語新增到業務詞彙表單中。檔案架構可以提供一些基本的線索,如:前臺程式碼及後臺程式碼。它們可以分別放在獨立的檔案中。開發者會發現,凡具有特定功能的模組程式碼都被放在獨立的資料夾中。按照這個線索,就知道如何進行查詢了。

  2、功能檔案的對映

  在使用者介面上寫一些可執行的功能程式碼塊。把重要的程式碼塊放到一個單獨的資料夾中,並對資料夾進行命名。這個資料夾有可能對團隊中的其他人有用,他們可以把該功能應用到專案程式設計中。

  3、單元測試

  如果採用單元測試,開發者可能會用到第三方框架。你可以用第三方框架來輔助測試。即使沒有找到合適的框架,仍然可以來做單元測試。當然,你也可以不採用單元測試,但我依然推薦你用,因為有助於你對原始碼中元件的理解。

  4、註釋

  原始碼中可能包含一些註釋,有的註釋對開發人員很有幫助,有的會讓人有所誤導或有的註釋可能過期了。如果你覺得註釋有問題,你可以通過偵錯程式追蹤有關程式碼,瞭解相關程式碼的意思。如果你發現錯誤的註釋,修改或刪除它們。

  5、視覺化工具

  在新的程式碼庫中使用語言程式碼分析工具。如:ObjectAid是一個極好的Java程式碼分析工具。這是 Eclipse IDE中的一個外掛。你可以建立物件來協助類圖,把java檔案拉到類圖中,就自動畫出類圖。

  6、設定斷點

  使用偵錯程式,設定一些斷點並執行檢視。這是第一次學習新的程式碼基礎。

  結論

  上述的分析過程採用自上而下的方法,能夠更好的幫助開發者學習新的程式碼庫。

  文章來源:larsavery.com

相關文章