最近有位問(wèn)：剛參加工作，看不懂代碼？

這篇文章我們就來(lái)簡(jiǎn)單分享一些看代碼的經(jīng)驗(yàn)。

1、了解項(xiàng)目整體架構(gòu)

在閱讀嵌入式代碼之前，我們需要對(duì)項(xiàng)目整體架構(gòu)有一個(gè)基本的了解。

公司里的項(xiàng)目，一般在做項(xiàng)目之前，都會(huì)進(jìn)行系統(tǒng)設(shè)計(jì)、編寫一些文檔、畫一些系統(tǒng)框圖。可以先找這些項(xiàng)目資料看一看。雖然我們后面可能只是負(fù)責(zé)某個(gè)模塊，但是還是很有必要先了解這個(gè)項(xiàng)目的總體框架。了解清楚整個(gè)項(xiàng)目有有哪些硬件模塊、哪些軟件模塊、有哪些組件、各個(gè)模塊之間的輸入輸出、各個(gè)模塊是如何協(xié)同工作、項(xiàng)目的主體業(yè)務(wù)是什么、主要功能有哪些等。

嵌入式代碼通常可以分解為幾個(gè)關(guān)鍵模塊，例如任務(wù)管理、內(nèi)存管理、通信協(xié)議等。將各個(gè)模塊分離出來(lái)，逐一閱讀和理解，可以更加清晰地掌握代碼的核心思想。

對(duì)項(xiàng)目整體架構(gòu)有一定了解之后，有助于我們更好地理解代碼中的邏輯。

2、熟悉通信部分代碼

項(xiàng)目里一般會(huì)劃分多個(gè)硬件/軟件模塊，這些模塊之間會(huì)進(jìn)行數(shù)據(jù)交互。

梳理清楚：

• 使用了哪些硬件通信接口？例如I2C、SPI、UART等。
• 線程通信？
• 進(jìn)程間通信？
• 網(wǎng)絡(luò)通信？
• 協(xié)議數(shù)據(jù)處理？
• 各個(gè)模塊的數(shù)據(jù)分類？

我們可以首先熟悉通信部分代碼，梳理清楚各模塊的交互。這一部分代碼一般是比較容易看懂的，基本是看懂了一條數(shù)據(jù)之后，類似的基本就看懂了。基本看懂之后，可以跟著數(shù)據(jù)的流向，看看拿到這些數(shù)據(jù)之后，去做了什么處理。

因?yàn)槟阒蟮墓ぷ鳎锌赡苁菍戇@一部分代碼。比如增加某個(gè)數(shù)據(jù)，要實(shí)現(xiàn)什么功能。

拿數(shù)據(jù) + 做邏輯

3、閱讀主業(yè)務(wù)模塊

業(yè)務(wù)邏輯模塊直接跟產(chǎn)品功能掛鉤，看懂這個(gè)模塊就可以很好地了解我們產(chǎn)品的功能。

業(yè)務(wù)邏輯作為最上層的模塊，可能有好幾個(gè)模塊都對(duì)其提供一些接口。

閱讀這一塊代碼需要注意的是：

每個(gè)功能具體的函數(shù)實(shí)現(xiàn)可能會(huì)嵌套好多層的代碼，剛開始千萬(wàn)不要一層一層點(diǎn)進(jìn)去閱讀、不要試圖看懂每個(gè)函數(shù)、每行代碼，不然只會(huì)越看越懵。

我們?cè)陂喿x這個(gè)模塊的代碼時(shí)，盡量沿著這個(gè)模塊的主線去閱讀，沿著主線盡可能快地弄清這個(gè)模塊做的事情，理解函數(shù)調(diào)用關(guān)系。等我們弄懂本模塊之后，日后對(duì)其它模塊感興趣再去仔細(xì)閱讀其具體實(shí)現(xiàn)也不遲。

4、了解單元測(cè)試測(cè)試用例

一般項(xiàng)目里模塊開發(fā)完成會(huì)編寫一些單元測(cè)試用例進(jìn)行自測(cè)。我們可以先不看單元測(cè)試模塊是如何實(shí)現(xiàn)的，可以先看一些各個(gè)模塊的測(cè)試用例，每個(gè)用例是如何跑的？輸入？輸出?

通過(guò)閱讀這些測(cè)試用例，可以幫助我們快速地理解各個(gè)模塊是如何觸發(fā)的，以及一些接口的使用方法。

5、實(shí)踐、分析日志

對(duì)代碼有了一定理解之后，肯定也會(huì)帶有很多困惑，這時(shí)候可以自己修改代碼/增加一些調(diào)試日志來(lái)幫我們理解代碼，有在線調(diào)試條件的可以進(jìn)行在線調(diào)試。

同時(shí)，我們需要大致熟悉項(xiàng)目整體的日志：

熟悉日志的格式。帶有時(shí)間戳？帶有模塊標(biāo)簽？日志等級(jí)？

了解應(yīng)用程序啟動(dòng)日志，通過(guò)日志了解啟動(dòng)做了哪些工作、經(jīng)過(guò)了哪些流程。

了解一些關(guān)鍵日志。主業(yè)務(wù)的日志？

跑跑一些用例，看看對(duì)應(yīng)的日志。

以上就是我們關(guān)于閱讀嵌入式代碼的一些分享。

如果文章對(duì)你有幫助，麻煩幫忙轉(zhuǎn)發(fā)。

本文轉(zhuǎn)載自公眾號(hào)|嵌入式大雜燴

作者 | 嵌入式大雜燴