建立良好的文檔習慣 - 專家教你如何成為一名優(yōu)秀的工程師

　　建立良好的文檔習慣

　　知識在于積累，但是人的記憶如果不經(jīng)常刷新是會容易遺忘的，和DRAM一個道理。因此如果不能定期刷新，那么請把經(jīng)驗都寫下來，成為一個本，通過各種網(wǎng)絡(luò)渠道存放起來，以便隨時翻查，這是“云硬盤”的一個最好的用法之一。

　　作為一個軟件工程師，自己的代碼風格的確自己很熟悉，所以寫代碼的時候很多時候不寫注釋，出現(xiàn)很多魔鬼數(shù)字，到處隨便定義變量，但是如果這樣的話不利于程序的維護以及傳承。舉個例子，一個ARM的linux程序，用以下定義，是否比在文檔內(nèi)嵌代碼強呢？

　　隨時備份自己的程序，編號以及時間戳做好。雖然軟件上面有很多很好用的工具，我相信大部分工程師都不會使用這些代碼維護工具。那么請看下個建議

　　軟件/硬件的框架的制定以及描述文檔的建立。建立了這些文檔，可以讓自己不斷的對自己的思維/想法進行糾正，這樣的話對自己的提升有很大幫助。

　　工欲善其事必先利其器

　　首先要做好一件事情，必須首先把工具搞好，比如FPGA開發(fā)，必須把開發(fā)環(huán)境搭建起來，如何進行驗證以及代碼編寫等，環(huán)境搭建有很多方法，要么找廠家FAE索取相關(guān)的經(jīng)驗，要么找資深工程師進行咨詢。

　　使用的工具正確的話，那么有時候事半功倍，好比上面截圖的代碼工具名字叫source insight，這個工具的功能強大，對于代碼分析能提高很多的效率。這些如果寫成了開發(fā)文檔，那么就是經(jīng)驗了，這些經(jīng)驗有時候?qū)τ诓锁B來說，就是一本圣經(jīng)，能夠縮短成為老鳥的時間。

　　建立良好的思維習慣

　　作為嵌入式軟件工程師，和ARM/單片機打交道超過10年，個人最反對的是使用debugger，除非特殊的純軟件算法，否則在很多混合場合是無法使用 debugger的，因為很多實時的信號過了就沒有了，等你停下來找原因，黃花菜都涼了。良好嚴謹?shù)乃季S方式，可以讓自己在碰到某些情況的時候迅速定位問題所在解決問題，而不是依靠debugger進行輔助設(shè)計。

　　結(jié)構(gòu)化的代碼，軟件為主的一個思想，這是很重要的指導思想。沒有哪個公司能夠把東西一步到位，所以寫程序不要認為你可以完全，連Microsoft都平均2年一個操作系統(tǒng)，何況我們作為IT人士，難道指望一個程序能活5年？因此程序要把自己的定位做好，別做萬金油，萬金油包治百病，但實際都不能根治。