【正文】 軟件設(shè)計規(guī)范制定： 審核： 批準： 文件編號生效日期版本號分發(fā)部門 修 訂 履 歷序號 版本修訂內(nèi)容 修訂人修訂日期會簽與文件發(fā)放：會簽部門 會簽人會簽日期簽收部門簽收人簽收日期 深圳市德卡科技有限公司文件編號文件版本A1生效日期軟件設(shè)計規(guī)范發(fā)行類別■新增 □修訂發(fā)行部門研發(fā)中心目 錄第一章、項目模塊劃分 15一、模塊劃分 15二、模塊命名 15第二章、文件格式 15一、c文件格式說明： 16文件創(chuàng)建及修改說明區(qū) 16頭文件引用區(qū) 16全局變量定義區(qū) 16驅(qū)動函數(shù)區(qū) 16應(yīng)用函數(shù)區(qū) 17文件結(jié)束說明 17二、h文件格式說明 17文件創(chuàng)建及修改說明區(qū) 17防重調(diào)用定義 18頭文件引用 18控制接口定義區(qū) 18常量定義區(qū) 19宏調(diào)用定義區(qū) 19類型定義區(qū) 19外部引用變量區(qū) 19外部引用函數(shù)區(qū) 20操作流程說明區(qū) 201文件結(jié)束說明 20第三章、命名規(guī)則 21一、函數(shù)命名規(guī)則 21二、變量命名規(guī)則 21三、宏命名規(guī)則 22四、文件命名規(guī)則 22五、新定義變量類型命名規(guī)則 22六、命名注意事項： 22標識符命名基本原則 23命名中若使用特殊約定或縮寫，則要有注釋說明 23局部循環(huán)變量也必須按照變量命名規(guī)則來定義 23不要用數(shù)字或較奇怪的字符來定義標識符 23用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等 23避免使用以下劃線開始和結(jié)尾的定義 23程序中不要出現(xiàn)僅靠大小寫區(qū)分的相似的標識符 23標識符縮寫 24函數(shù)名應(yīng)準確描述函數(shù)的功能 24避免使用無意義或含義不清的動詞為函數(shù)命名 24第四章、代碼書寫規(guī)范 24一、基本原則 24二、排版 24縮進風(fēng)格 24不要使用【TAB】鍵 24空行 24語句長度要小于80個字符 25長語句換行 25長表達式換行 26若函數(shù)的參數(shù)較長，則要進行適當(dāng)?shù)膭澐?26一行只寫一條語句 26括號{} 27語句縮進要求 271分界符 281空格 29三、注釋 30注釋量 30函數(shù)頭部注釋 30代碼與注釋同時修改 31注釋的內(nèi)容要清楚、明了，含義準確，防止注釋二義性 31避免在注釋中使用縮寫，特別是非常用縮寫 31注釋書寫位置 31變量、常量命名不能充分自注釋的，必須加以注釋 32數(shù)據(jù)結(jié)構(gòu)命名不能充分自注釋的，必須加以注釋 32全局變量注釋 32注釋要與說描述的內(nèi)容進行同樣的縮排 321將注釋與其上面的代碼用空行隔開 331連續(xù)case語句處理時，必須編寫注釋 341代碼或表達式的中間禁止插入注釋 361通過正確命名使代碼成為自注釋的 361在代碼的功能、意圖層次上進行注釋，提供有用、額外的信息 361在程序塊的結(jié)束行右方加注釋標記，以表明某程序塊的結(jié)束 361注釋格式 371采用中文注釋 371使用 if0和 endif注釋代碼塊 37注釋不能嵌套 37四、代碼可讀性 37使用小括號明確表達式的操作順序 37用有意義的枚舉和宏替代數(shù)字 38源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰 39用多行簡單語句替代復(fù)雜語句 39五、變量，結(jié)構(gòu) 40公共變量 去掉沒必要的公共變量 仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系 明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系 要謹慎向公共變量傳遞數(shù)據(jù) 防止局部變量與公共變量同名。 公共變量僅由模塊或函數(shù)創(chuàng)建和修改，其余模塊和函數(shù)只能訪問 40局部變量 4嚴禁使用未經(jīng)初始化的變量作為右值 4不使用與硬件或軟件環(huán)境關(guān)系密切的變量 4變量聲明時，同一類型，不同意義的多個變量，要分行，便于區(qū)分 4對只設(shè)置一次的變量，宜使用“const”限定詞進行聲明 4避免在函數(shù)中使用 static 局部變量 41數(shù)組 4數(shù)組大小及初始值要明確定義 4數(shù)組、結(jié)構(gòu)和聯(lián)合的初始化列表應(yīng)顯式描述 41結(jié)構(gòu)、聯(lián)合 4結(jié)構(gòu)的功能要單一，是針對一種事務(wù)的抽象 4不要設(shè)計面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu) 4不同結(jié)構(gòu)間的關(guān)系不要過于復(fù)雜 4結(jié)構(gòu)中元素的個數(shù)應(yīng)適中 4結(jié)構(gòu)體中元素的布局 4結(jié)構(gòu)體設(shè)計要考慮兼容性 4跨平臺數(shù)據(jù)結(jié)構(gòu)，要考慮字節(jié)順序及對齊問題 4struct或union類型中至少應(yīng)有一個成員 4struct或union類型的成員類型 46枚舉 4枚舉元素的初始化應(yīng)完整 47自定義數(shù)據(jù)類型 4合理地設(shè)計數(shù)據(jù)并使用自定義數(shù)據(jù)類型 4自定義數(shù)據(jù)類型命名要恰當(dāng) 47類型轉(zhuǎn)換 4謹慎使用數(shù)據(jù)類型的強制轉(zhuǎn)換 4了解編譯系統(tǒng)默認的數(shù)據(jù)類型轉(zhuǎn)換 4應(yīng)禁止 signed 類型與 unsigned 類型之間的隱式轉(zhuǎn)化 4應(yīng)禁止 int 類型與 float 類型的隱式轉(zhuǎn)化 48指針 4不應(yīng)對指針變量使用強制類型轉(zhuǎn)換賦值 4不應(yīng)把自動類型的局部變量的地址賦值給外部指針 4指針的指針不應(yīng)超過兩級 4指向不同數(shù)據(jù)類型的指針之間不應(yīng)相互轉(zhuǎn)換 4指針轉(zhuǎn)換過程中不應(yīng)丟失指針的const、 volatile屬性 4只有指向數(shù)組的指針才允許進行算術(shù)運算 4只有指向同一數(shù)組的兩個指針才允許相減 4只有指向同一數(shù)組的兩個指針才允許用、=、和=等關(guān)系運算符進行比較 4指針的索引值不應(yīng)為負 50、不應(yīng)對指針值可能為NULL的指針進行算術(shù)運算 50、調(diào)用返回類型為指針的函數(shù)后，應(yīng)進行是否為空的判斷 50、局部變量的地址不應(yīng)在本對象消亡后傳給另外一個對象 50、一個未知大小的對象的指針不應(yīng)成為加法或者減法操作的左操作數(shù) 51六、函數(shù) 51函數(shù)編寫原則 5明確函數(shù)功能，精確（而不是近似）地實現(xiàn)函數(shù)設(shè)計 5函數(shù)的規(guī)模盡量限制在200行以內(nèi) 5一個函數(shù)僅完成一件功能 5為簡單功能編寫函數(shù) 5不要設(shè)計多用途面面俱到的函數(shù) 5函數(shù)功能具有可預(yù)測性 5函數(shù)功能具有獨立性 5防止函數(shù)出現(xiàn)隨機內(nèi)聚 5功能不明確的較小函數(shù)，可以不必存在 5設(shè)計高扇入、合理扇出（小于7）的函數(shù) 5減少函數(shù)本身或函數(shù)間的遞歸調(diào)用 5降低函數(shù)間的耦合度 54函數(shù)參數(shù) 5明確接口函數(shù)參數(shù)的合法性檢查者 5防止將函數(shù)的參數(shù)作為工作變量 5避免設(shè)計多參數(shù)函數(shù)，不使用的參數(shù)從接口中去掉 5非調(diào)度函數(shù)應(yīng)減少或防止控制參數(shù)，盡量只使用數(shù)據(jù)參數(shù) 5檢查函數(shù)所有參數(shù)輸入的有效性 5檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等 5調(diào)用函數(shù)時參數(shù)類型要一致 5避免使用BOOL參數(shù) 5在函數(shù)參數(shù)中不應(yīng)使用static存儲類標識符 5函數(shù)參數(shù)數(shù)量 5宜避免函數(shù)參數(shù)在調(diào)用中未被使用 57函數(shù)返回 5對所調(diào)用函數(shù)的錯誤返回碼要仔細、全面地處理 5函數(shù)的返回值要清楚、明了，讓使用者不容易忽視錯誤情況 5函數(shù)返回值要與賦值變量類型一致 5對于提供了返回值的函數(shù)，在引用時最好使用其返回值 5函數(shù)只有一個出口 58可重入函數(shù) 5可重入函數(shù)使用局部變量 5可重入函數(shù)使用全局變量 58函數(shù)模塊劃分 5仔細分析模塊的功能，進行函數(shù)的劃分和組織 5如果多段代碼重復(fù)做同一件事情，那么在函數(shù)的劃分上可能存在問題 5函數(shù)內(nèi)部的代碼結(jié)構(gòu)順序 59循環(huán)語句 60、循環(huán)控制變量的類型應(yīng)為整型 60、循環(huán)控制變量應(yīng)為局部變量 6for循環(huán)控制語句中的3 個表達式只應(yīng)和循環(huán)控制相關(guān) 6for循環(huán)不宜只執(zhí)行一次 61判斷語句 6不要輕易用條件分支去替換邏輯表達式 6switch語句中不應(yīng)只包含default語句 6所有非空的switch case子句都應(yīng)以break 語句結(jié)束 6switch控制表達式不應(yīng)是一個常量或邏輯表達式 6每一個switch語句都應(yīng)至少有一個case子句 6case表達式的類型應(yīng)與switch控制表達式的類型一致 6case表達式的大小不應(yīng)超過switch控制表達式的大小 61賦值語句 6盡量不使用條件賦值語句 62其他注意事項 6避免函數(shù)中不必要語句，防止程序中的垃圾代碼 6在多任務(wù)操作系統(tǒng)的環(huán)境下編程，更要注意函數(shù)可重入性的構(gòu)造 6將常用較長變量用宏替代 62七、預(yù)處理 62宏 6用宏定義表達式時，要使用完備的括號 6將宏所定義的多條表達式放在大括號中 6使用宏時，不允許參數(shù)發(fā)生變化 6函數(shù)類宏調(diào)用時參數(shù)要完整 64條件編譯 6預(yù)處理語句“if”和“endif”不應(yīng)分散在不同的文件之中 6被包含文件中的“else”、“elseif”、“endif”不應(yīng)與父文件中的“if” 匹配 6“if”表達式中使用的宏應(yīng)該已經(jīng)被定義，并且“if”表達式只能包含整型常量 6宏如果需要被重定義，應(yīng)該先用“undef”解除前面的定義 64八、中斷 64中斷服務(wù)程序不應(yīng)有返回值 64中斷服務(wù)程序中不應(yīng)使用printf()函數(shù) 64對于中斷中使用到的非局部變量，在中斷處理函數(shù)中應(yīng)對其進行入棧保護 64調(diào)用中斷處理程序中的變量要進行開關(guān)中斷處理 64對于開關(guān)中斷，要注意成對匹配 64中斷服務(wù)程序代碼要簡單化 65九、程序可測性 65原則 6統(tǒng)一的調(diào)測開關(guān)及打印函數(shù) 6統(tǒng)一的打印信息串格式 6正式軟件產(chǎn)品中應(yīng)把斷言及其它調(diào)測代碼去掉（即把有關(guān)的調(diào)測開關(guān)關(guān)掉） 6用調(diào)測開關(guān)切換軟件的DEBUG版和正式版 6軟件DEBUG版和發(fā)行版在實現(xiàn)功能上具有一致性 6構(gòu)造測試環(huán)境和測試用例 6預(yù)先設(shè)計程序調(diào)測的方法和手段及各種調(diào)測開關(guān) 6調(diào)測開關(guān)應(yīng)分為不同級別和類型 66斷言 6使用斷言來發(fā)現(xiàn)軟件問題，提高代碼可測性 6用斷言來檢查程序正常運行時不應(yīng)發(fā)生但在調(diào)測時有可能發(fā)生的非法情況 6不能用斷言來檢查最終產(chǎn)品肯定會出現(xiàn)且必須處理的錯誤情況 6對較復(fù)雜的斷言加上明確的注釋 6用斷言確認函數(shù)的參數(shù) 6用斷言保證沒有定義的特性或功能不被使用 6用斷言對程序開發(fā)環(huán)境（OS/Compiler/Hardware）的假設(shè)進行檢查 6編寫防錯程序，然后在處理錯誤之后可用斷言宣布發(fā)生錯誤 68十、程序效率 69原則 6編程時要經(jīng)常注意代碼的效率 6提高代碼效率的前提 6局部效率應(yīng)為全局效率服務(wù) 6合理劃分模塊函數(shù) 6不應(yīng)花過多的時間拼命地提高調(diào)用不很頻繁的函數(shù)代碼效率 70、不要一味追求緊湊的代碼 70、不應(yīng)存在執(zhí)行不到的代碼 70、去掉沒必要的全局變量 70方法 70、解決軟件空間效率1 70、解決軟件空間效率2 7循環(huán)體內(nèi)工作量最小化 7仔細分析有關(guān)算法，并進行優(yōu)化 7仔細考查、分析系統(tǒng)及模塊處理輸入（如事務(wù)、消息等）的方式，并加以改進 7直接用匯編編寫調(diào)用頻繁或性能要求極高的函數(shù) 7在多重循環(huán)中，應(yīng)將最忙的循環(huán)放在最內(nèi)層 7盡量減少循環(huán)嵌套層次 7盡量不在循環(huán)體內(nèi)放置判斷語句 7盡量用乘法或其它方法代替除法，特別是浮點運算中的除法 7應(yīng)注意switchcase語句的使用 74十一、程序質(zhì)量 74原則 7代碼質(zhì)量保證優(yōu)先原則 7合理劃分子模塊，提高可