Ⅰ 寫在前面 不知道大家有沒有這樣的感受：看到不規范（雜亂差）的代碼，瞬間就沒有看下去的欲望了。 相信大家看到標題都應該能明白編程的規范及原則對于每一個軟件開發的工程師來說是多么重要。 初學者編寫測試程序、小的模塊程序也許不能感受它的重要性；但有經驗及大型項目開發的人就知道程序的規范性對他們來說是有多么的重要。 Ⅱ 關于編程規范及原則 編程規范也就是編寫出簡潔、可維護、可靠、可測試、高效、可移植的代碼，提高產品代碼的質量。 本文針對嵌入式，主要結合C語言編程的規范給大家講述。 1. 頭文件 對于C語言來說，頭文件的設計體現了大部分的系統設計，不合理的頭文件布局是編譯時間過長的原因。 有很多人將工程中所有的頭文件包含在一個include.h文件中，然后在每一個.c源代碼文件中包含include.h頭文件，這樣做可以讓代碼看上去簡潔，但實際忽視了編譯效率問題，而且代碼的可移植性也不好。 原則： A. 頭文件中適合放置接口的聲明，不適合放置實現； B. 頭文件應當職責單一; C. 頭文件應向穩定的方向包含。 規則： A. 每一個.c文件應有一個同名.h文件，用于聲明需要對外公開的接口; B. 禁止頭文件循環依賴; C. .c/.h文件禁止包含用不到的頭文件; D. 頭文件應當自包含; E. 總是編寫內部#include保護符（ #define 保護）; F. 禁止在頭文件中定義變量; G. 只能通過包含頭文件的方式使用其他.c提供的接口，禁止在.c中通過extern的方式使用外部函數接口、變量; H. 禁止在extern "C"中包含頭文件。 建議： A. 一個模塊通常包含多個.c文件，建議放在同一個目錄下，目錄名即為模塊名。為方便外部使用者，建議每一個模塊提供一個.h，文件名為目錄名; B. 如果一個模塊包含多個子模塊，則建議每一個子模塊提供一個對外的.h，文件名為子模塊名（降低接口使用者的編寫難度）; C. 頭文件不要使用非習慣用法的擴展名，如.inc; D. 同一產品統一包含頭文件排列方式。 2. 函數 函數設計的要點：編寫整潔的函數，同時把代碼有效組織起來。 函數整潔的要求：代碼簡單直接、不隱藏設計者的意圖、用干凈利落的抽象和直截了當的控制語句將函數有機組織起來。 原則： A. 一個函數僅完成一件功能; B. 重復代碼應該盡可能提煉成函數. 規則： A. 避免函數過長，新增函數不超過100行（非空非注釋行）; B. 避免函數的代碼塊嵌套過深，新增函數的代碼塊嵌套不超過4層; C. 可重入函數應避免使用共享變量；若需要使用，則應通過互斥手段（關中斷、信號量）對其加以保護; D. 對參數的合法性檢查，由調用者負責還是由接口函數負責，應在項目組/模塊內應統一規定; E. 對函數的錯誤返回碼要全面處理; F. 設計高扇入，合理扇出（小于7）的函數; G. 廢棄代碼（沒有被調用的函數和變量)要及時清除。 建議： A. 函數不變參數使用const; B. 函數應避免使用全局變量、靜態局部變量和I/O操作，不可避免的地方應集中使用; C. 檢查函數所有非參數輸入的有效性，如數據文件、公共變量等; D. 函數的參數個數不超過5個; E. 除打印類函數外，不要使用可變長參函數; F. 在源文件范圍內聲明和定義的所有函數，除非外部可見，否則應該增加static關鍵字。 3. 標識符命名與定義 程序命名是一個關鍵，如果命名不規范，自己寫的代碼，時間長了恐怕連自己都不知道是什么意思了。 3.1通用命名規則 常見命名風格： A. 用下劃線?_?分割，如text_mutex; B. 大小寫字母混用，如ReadRFCText。 規則： A. 標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產生誤解； B. 除了常見的通用縮寫以外，不使用單詞縮寫，不得使用漢語拼音; C. 產品/項目組內部應保持統一的命名風格. 建議： A. 用正確的反義詞組命名具有互斥意義的變量或相反動作的函數等;