軟件設(shè)計規(guī)范方案

深知I市德卡科技盲眼公m

SHENZHENDECARDSMARTCARDTECHCO.,LTD.

軟件設(shè)計標準

制定:

文件編號生效日期版本號

分

發(fā)

部

h

修訂履歷

序號版本修訂內(nèi)容修訂人修訂日期

會簽與文件發(fā)放：

會簽部門會簽人會簽日期簽收部門簽收人簽收日期

文件編號

?DM深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

目錄

第一章、工程模塊劃分...............................................24

一、模塊劃分.......................................................24

二、模塊命名.......................................................25

第二章、文件格式...................................................26

一、C文件格式說明：................................................26

1s文件創(chuàng)立及修改說明區(qū).............................................26

2、頭文件引用區(qū).....................................................26

3、全局變量定義區(qū)...................................................27

4、驅(qū)動函數(shù)區(qū)......................................................27

5、應(yīng)用函數(shù)區(qū)......................................................27

6、文件完畢說明.....................................................28

二、h文件格式說明..................................................28

1、文件創(chuàng)立及修改說明區(qū).............................................28

2、防重調(diào)用定義.....................................................29

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

3、頭文件引用......................................................29

4、控制接口定義區(qū)..................................................29

5、常量定義區(qū).......................................................29

6、宏調(diào)用定義區(qū).....................................................30

7、類型定義區(qū)......................................................30

8、外部引用變量區(qū)...................................................30

9、外部引用函數(shù)區(qū)...................................................31

10、操作流程說明區(qū).................................................31

11、文件完畢說明...................................................32

第三章、命名規(guī)那么.................................................32

一、函數(shù)命名規(guī)那么.................................................32

二、變量命名規(guī)那么.................................................33

三、宏命名規(guī)那么...................................................33

四、文件命名規(guī)那么.................................................34

五、新定義變量類型命名規(guī)那么.......................................34

六、命名考前須知：.................................................34

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

1、標識符命名根本原那么.............................................34

2、命名中假設(shè)使用特殊約定或縮寫，那么要有注釋說明...................34

3、局部循環(huán)變量也必須按照變量命名規(guī)那么來定義.......................35

4、不要用數(shù)字或較奇怪的字符來定義標識符............................35

5、用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等........35

6、防止使用以下劃線開場和結(jié)尾的定義.................................35

7、程序中不要出現(xiàn)僅靠大小寫區(qū)分的相似的標識符.......................35

8、標識符縮寫......................................................36

9、函數(shù)名應(yīng)準確描述函數(shù)的功能......................................36

10、防止使用無意義或含義不清的動詞為函數(shù)命名.......................36

第四章、代碼書寫標準...............................................36

一、根本原那么.....................................................36

二、排版...........................................................36

1、縮進風格.........................................................36

2、不要使用［TAB］鍵...............................................36

3、空行.............................................................37

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

4、語句長度要小于80個字符.........................................38

5、長語句換行......................................................38

6、長表達式換行.....................................................38

7、假設(shè)函數(shù)的參數(shù)較長，那么要進展適當?shù)膭澐?.......................39

8、一行只寫一條語句.................................................39

9、括號{}...........................................................39

10、語句縮進要求...................................................40

11、分界符.........................................................41

12、空格...........................................................42

三、注釋...........................................................43

1、注釋量..........................................................43

2、函數(shù)頭部注釋....................................................44

3、代碼與注釋同時修改..............................................44

4、注釋的內(nèi)容要清楚、明了，含義準確，防止注釋二義性................44

5、防止在注釋中使用縮寫，特別是非常用縮寫..........................44

6、注釋書寫位置....................................................44

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

7、變量、常量命名不能充分自注釋的，必須加以注釋....................45

8、數(shù)據(jù)構(gòu)造命名不能充分自注釋的，必須加以注釋......................46

9、全局變量注釋....................................................46

10、注釋要與說描述的內(nèi)容進展同樣的縮排.............................47

1K將注釋與其上面的代碼用空行隔開.................................48

12、連續(xù)case語句處理時，必須編寫注釋..............................48

13、代碼或表達式的中間制止插入注釋.................................50

14、通過正確命名使代碼成為自注釋的.................................50

15、在代碼的功能、意圖層次上進展注釋，提供有用、額外的信息.........50

16、在程序塊的完畢行右方加注釋標記，以說明某程序塊的完畢...........51

17、注釋格式.......................................................51

18、采用中文注釋...................................................52

19、使用#if0和#endif注釋代碼塊....................................52

20、注釋不能嵌套...................................................52

四、代碼可讀性.....................................................52

1、使用小括號明確表達式的操作順序...................................52

文件編號

IK4深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

2、用有意義的枚舉和宏替代數(shù)字.......................................53

3、源程序中關(guān)系較為嚴密的代碼應(yīng)盡可能相鄰...........................54

4、用多行簡單語句替代復(fù)雜語句......................................54

五、變量，構(gòu)造.....................................................55

1、公共變量.........................................................55

1.1、去掉沒必要的公共變量...........................................55

1.2、仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系…55

1.3、明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系.................55

1.4、要慎重向公共變量傳遞數(shù)據(jù).......................................56

1.5、防止局部變量與公共變量同名。...................................56

1.6、公共變量僅由模塊或函數(shù)創(chuàng)立和修改，其余模塊和函數(shù)只能訪問.......56

2、局部變量.........................................................56

2.1、嚴禁使用未經(jīng)初始化的變量作為右值...............................56

2.2、不使用與硬件或軟件環(huán)境關(guān)系密切的變量...........................56

2.3、變量聲明時，同一類型，不同意義的多個變量，要分行，便于區(qū)分.....57

2.4、對只設(shè)置一次的變量，宜使用''const”限定詞進展聲明...............57

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

2.5、防止在函數(shù)中使用static局部變量.................................57

3、數(shù)組.............................................................57

3.1、數(shù)組大小及初始值要明確定義.....................................57

3.2、數(shù)組、構(gòu)造和聯(lián)合的初始化列表應(yīng)顯式描述.........................57

4、構(gòu)造、聯(lián)合......................................................58

4.1、構(gòu)造的功能要單一，是針對一種事務(wù)的抽象.........................58

4.2、不要設(shè)計面面俱到、非常靈活的數(shù)據(jù)構(gòu)造...........................59

4.3、不同構(gòu)造間的關(guān)系不要過于復(fù)雜...................................59

4.4、構(gòu)造中元素的個數(shù)應(yīng)適中.........................................60

4.5、構(gòu)造體中元素的布局.............................................61

4.6、構(gòu)造體設(shè)計要考慮兼容性.........................................62

4.7、跨平臺數(shù)據(jù)構(gòu)造，要考慮字節(jié)順序及對齊問題.......................62

4.8、struct或union類型中至少應(yīng)有一個成員...........................63

4.9、struct或union類型的成員類型...................................63

5、枚舉.............................................................64

5.1、枚舉元素的初始化應(yīng)完整.........................................64

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

6、自定義數(shù)據(jù)類型...................................................64

6.1、合理地設(shè)計數(shù)據(jù)并使用自定義數(shù)據(jù)類型.............................64

6.2、自定義數(shù)據(jù)類型命名要恰當.......................................64

7、類型轉(zhuǎn)換.........................................................65

7.1、慎重使用數(shù)據(jù)類型的強制轉(zhuǎn)換.....................................65

7.2,了解編譯系統(tǒng)默認的數(shù)據(jù)類型轉(zhuǎn)換.................................65

73、應(yīng)制止signed類型與unsigned類型之間的隱式轉(zhuǎn)化...............65

7.4、應(yīng)制止int類型與float類型的隱式轉(zhuǎn)化...........................65

8、指針.............................................................65

8.1、不應(yīng)對指針變量使用強制類型轉(zhuǎn)換賦值.............................65

8.2、不應(yīng)把自動類型的局部變量的地址賦值給外部指針...................65

8.3、指針的指針不應(yīng)超過兩級.........................................66

8.4、指向不同數(shù)據(jù)類型的指針之間不應(yīng)相互轉(zhuǎn)換.........................66

8.5、指針轉(zhuǎn)換過程中不應(yīng)喪失指針的const、volatile屬性................66

8.6、只有指向數(shù)組的指針才允許進展算術(shù)運算...........................66

8.7、只有指向同一數(shù)組的兩個指針才允許相減...........................67

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

8.8、只有指向同一數(shù)組的兩個指針才允許用＞、＞=、＜和＜=等關(guān)系運算符進展比擬67

8.9、指針的索引值不應(yīng)為負...........................................68

8.10、不應(yīng)對指針值可能為NULL的指針進展算術(shù)運算....................68

8.11、調(diào)用返回類型為指針的函數(shù)后，應(yīng)進展是否為空的判斷.............68

8.12、局部變量的地址不應(yīng)在本對象消亡后傳給另外一個對象.............68

8.13、一個未知大小的對象的指針不應(yīng)成為加法或者減法操作的左操作數(shù)……69

六、函數(shù)...........................................................69

1、函數(shù)編寫原那么...................................................69

1.1、明確函數(shù)功能，準確〔而不是近似〕地實現(xiàn)函數(shù)設(shè)計.................69

1.2、函數(shù)的規(guī)模盡量限制在200行以內(nèi).................................69

1.3、一個函數(shù)僅完成一件功能.........................................69

1.4、為簡單功能編寫函數(shù).............................................69

1.5、不要設(shè)計多用途面面俱到的函數(shù)...................................70

1.6、函數(shù)功能具有可預(yù)測性...........................................70

1.7、函數(shù)功能具有獨立性.............................................71

1.8、防止函數(shù)出現(xiàn)隨機內(nèi)聚...........................................72

文件編號

IK4深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

1.9、功能不明確的較小函數(shù)，可以不必存在.............................73

1.10、設(shè)計高扇入、合理扇出〔小于7〕的函數(shù)..........................73

1.11、減少函數(shù)本身或函數(shù)間的遞歸調(diào)用...............................73

1.12、降低函數(shù)間的耦合度...........................................73

2、函數(shù)參數(shù).........................................................74

2.1、明確接口函數(shù)參數(shù)的合法性檢查者.................................74

2.2、防止將函數(shù)的參數(shù)作為工作變量...................................74

2.3、防止設(shè)計多參數(shù)函數(shù)，不使用的參數(shù)從接口中去掉...................75

2.4、非調(diào)度函數(shù)應(yīng)減少或防止控制參數(shù)，盡量只使用數(shù)據(jù)參數(shù).............75

2.5、檢查函數(shù)所有參數(shù)輸入的有效性...................................76

2.6、檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等.........76

2.7、調(diào)用函數(shù)時參數(shù)類型要一致.......................................77

2.8、防止使用BOOL參數(shù).............................................77

2.9、在函數(shù)參數(shù)中不應(yīng)使用static存儲類標識符.........................77

2.10、函數(shù)參數(shù)數(shù)量..................................................77

2.11、宜防止函數(shù)參數(shù)在調(diào)用中未被使用................................77

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

3、函數(shù)返回.........................................................77

3.1、對所調(diào)用函數(shù)的錯誤返回碼要仔細、全面地處理.....................77

3.2、函數(shù)的返回值要清楚、明了，讓使用者不容易無視錯誤情況...........77

3.3、函數(shù)返回值要與賦值變量類型一致.................................77

3.4、對于提供了返回值的函數(shù)，在引用時最好使用其返回值...............78

3.5、函數(shù)只有一個出口...............................................78

4、可重入函數(shù)......................................................78

4.1、可重入函數(shù)使用局部變量.........................................78

4.2、可重入函數(shù)使用全局變量.........................................78

5、函數(shù)模塊劃分.....................................................79

5.1、仔細分析模塊的功能，進展函數(shù)的劃分和組織.......................79

5.2、如果多段代碼重復(fù)做同一件事情，那么在函數(shù)的劃分上可能存在問題.….…79

5.3、函數(shù)內(nèi)部的代碼構(gòu)造順序.........................................80

6、循環(huán)語句.........................................................81

6.1、循環(huán)控制變量的類型應(yīng)為整型.....................................81

6.2、循環(huán)控制變量應(yīng)為局部變量.......................................81

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

6.3、for循環(huán)控制語句中的3個表達式只應(yīng)和循環(huán)控制相關(guān)...............81

6.4、for循環(huán)不宜只執(zhí)行一次..........................................82

7、判斷語句.........................................................82

7.1、不要輕易用條件分支去替換邏輯表達式.............................82

7.2、switch語句中不應(yīng)只包含default語句..............................82

7.3、所有非空的switchcase子句都應(yīng)以break語句完畢..................82

74、switch控制表達式不應(yīng)是一個常量或邏輯表達式.....................82

75、每一個switch語句都應(yīng)至少有一個case子句........................82

7.6、case表達式的類型應(yīng)與switch控制表達式的類型一致................82

7.7、case表達式的大小不應(yīng)超過switch控制表達式的大小................82

8、賦值語句.........................................................82

8.1、盡量不使用條件賦值語句.........................................82

9、其他考前須知.....................................................83

9.1、防止函數(shù)中不必要語句，防止程序中的垃圾代碼.....................83

9.2、在多任務(wù)操作系統(tǒng)的環(huán)境下編程，更要注意函數(shù)可重入性的構(gòu)造.......83

9.3、將常用較長變量用宏替代.........................................83

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

七、預(yù)處理.........................................................83

1、宏...............................................................83

1.1、用宏定義表達式時，要使用完備的括號.............................83

12、將宏所定義的多條表達式放在大括號中.............................84

1.3、使用宏時，不允許參數(shù)發(fā)生變化...................................84

1.4、函數(shù)類宏調(diào)用時參數(shù)要完整.......................................85

2、條件編譯.........................................................85

2.1、預(yù)處理語句“#if”和"#endif”不應(yīng)分散在不同的文件之中...........85

2.2、被包含文件中的、'#else"、"#elseif"、"#endif"不應(yīng)與父文件中的、'#if"匹配

...................................................................................................................................................85

2.3、、'#if"表達式中使用的宏應(yīng)該已經(jīng)被定義，并且、'#if"表達式只能包含整型常量85

2.4、宏如果需要被重定義，應(yīng)該先用、'#undef"解除前面的定義...........86

八、中斷...........................................................86

1、中斷效勞程序不應(yīng)有返回值........................................86

2、中斷效勞程序中不應(yīng)使用printf()函數(shù)................................86

3、對于中斷中使用到的非局部變量，在中斷處理函數(shù)中應(yīng)對其進展入棧保護..86

4、調(diào)用中斷處理程序中的變量要進展開關(guān)中斷處理......................86

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

5、對于開關(guān)中斷，要注意成對匹配.....................................86

6、中斷效勞程序代碼要簡單化........................................86

九、程序可測性.....................................................87

1、原那么...........................................................87

1.1、統(tǒng)一的調(diào)測開關(guān)及打印函數(shù).......................................87

1.2、統(tǒng)一的打印信息串格式...........................................87

1.3、正式軟件產(chǎn)品中應(yīng)把斷言及其它調(diào)測代碼去掉〔即把有關(guān)的調(diào)測開關(guān)關(guān)掉〕87

14、用調(diào)測開關(guān)切換軟件的DEBUG版和正式版..........................87

1.5、軟件DEBUG版和發(fā)行版在實現(xiàn)功能上具有一致性...................87

1.6、構(gòu)造測試環(huán)境和測試用例.........................................87

1.7、預(yù)先設(shè)計程序調(diào)測的方法和手段及各種調(diào)測開關(guān).....................88

1.8、調(diào)測開關(guān)應(yīng)分為不同級別和類型...................................88

2、斷言.............................................................88

2.1、使用斷言來發(fā)現(xiàn)軟件問題，提高代碼可測性.........................88

2.2、用斷言來檢查程序正常運行時不應(yīng)發(fā)生但在調(diào)測時有可能發(fā)生的非法情況89

2.3、不能用斷言來檢查最終產(chǎn)品肯定會出現(xiàn)且必須處理的錯誤情況.........89

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

2.4、對較復(fù)雜的斷言加上明確的注釋...................................89

2.5、用斷言確認函數(shù)的參數(shù)...........................................89

2.6、用斷言保證沒有定義的特性或功能不被使用.........................90

2.7、用斷言對程序開發(fā)環(huán)境〔OS/Compiler/Hardware〕的假設(shè)進展檢查....90

2.8、編寫防錯程序，然后在處理錯誤之后可用斷言宣布發(fā)生錯誤...........91

十、程序效率.......................................................92

1、原那么...........................................................92

1.1、編程時要經(jīng)常注意代碼的效率.....................................92

1.2、提高代碼效率的前提.............................................92

1.3、局部效率應(yīng)為全局效率效勞.......................................92

1.4、合理劃分模塊函數(shù)...............................................93

1.5、不應(yīng)花過多的時間拼命地提高調(diào)用不很頻繁的函數(shù)代碼效率...........93

1.6、不要一味追求緊湊的代碼.........................................93

1.7、不應(yīng)存在執(zhí)行不到的代碼.........................................93

1.8、去掉沒必要的全局變量...........................................93

2、方法.............................................................93

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

2.1、解決軟件空間效率1...................................................................................................93

2.2、解決軟件空間效率2...................................................................................................94

2.3、循環(huán)體內(nèi)工作量最小化...........................................95

2.4、仔細分析有關(guān)算法，并進展優(yōu)化...................................95

2.5、仔細考察、分析系統(tǒng)及模塊處理輸入〔如事務(wù)、消息等〕的方式，并加以改良95

2.6、直接用匯編編寫調(diào)用頻繁或性能要求極高的函數(shù).....................95

2.7、在多重循環(huán)中，應(yīng)將最忙的循環(huán)放在最內(nèi)層.........................96

2.8、盡量減少循環(huán)嵌套層次...........................................96

2.9、盡量不在循環(huán)體內(nèi)放置判斷語句...................................96

2.10、盡量用乘法或其它方法代替除法，特別是浮點運算中的除法.........98

2.11s應(yīng)注意switch-case語句的使用.................................98

H---、程序質(zhì)量.....................................................98

1、原那么...........................................................98

1.1、代碼質(zhì)量保證優(yōu)先原那么.........................................98

1.2、合理劃分子模塊，提高可移植性和可重用性.........................99

1.3、提供良好的接口界面.............................................99

文件編號

IK4深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

1.4、系統(tǒng)具有一定容錯能力...........................................99

2、方法.............................................................99

2.1、認認真真處處理理程程序序所所能能遇遇到到的的各各種種出出錯錯情情況況..........................................................99

2.2、系統(tǒng)運行之初，要初始化有關(guān)變量及運行環(huán)境，防止未經(jīng)初始化的變量被引用99

2.3、系統(tǒng)運行之初，要對加載到系統(tǒng)中的數(shù)據(jù)進展一致性檢查.............99

2.4、嚴禁隨意更改其它模塊或系統(tǒng)的有關(guān)設(shè)置和配置....................100

2.5、不能隨意改變與其它模塊的接口..................................100

2.6、防止內(nèi)存操作越界..............................................100

2.7、編程時，要防止差1錯誤........................................101

2.8、要時刻注意易混淆的操作符......................................101

2.9、條件判斷語句必須處理所有情況..................................101

2.10、不要用goto語句..............................................101

2.11、盡量都采用標準語句和標準庫函數(shù)..............................102

2.12、防止使用嵌入式匯編...........................................102

2.13、精心構(gòu)造算法，并對其性能、效率進展測試......................102

2.14、對較關(guān)鍵的算法最好使用其它算法來確認.........................102

文件編號

IK4深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

2.15s時刻注意表達式是否會上溢、下溢.............................102

2.16、使用變量時要注意其邊界值的情況.............................103

2.17、注意程序代碼是否超過系統(tǒng)有關(guān)限制...........................103

2.18、循環(huán)、分支層次不要超過五層.................................103

2.19、不要比擬浮點數(shù)的相等.......................................103

2.20、關(guān)注共用體的存儲、對齊模式.................................103

2.21、頭文件中不應(yīng)有對象或函數(shù)的定義.............................103

2.22、不應(yīng)單獨使用小寫字母"I"或大寫字母"?！弊鳛樽兞棵?........103

2.23、函數(shù)聲明時參數(shù)不應(yīng)只有類型名沒有標識符.....................104

2.24、不應(yīng)對有符號數(shù)進展位運算...................................104

2.25、無格式的字符型不應(yīng)與負數(shù)常量和零比擬.......................104

2.26、無符號值不應(yīng)與負數(shù)常量比擬.................................104

2.27、對變量進展移位操作應(yīng)保證不會產(chǎn)生溢出和數(shù)據(jù)截短.............104

2.28、不應(yīng)在布爾表達式中使用賦值操作符...........................104

2.29、不應(yīng)對布爾表達式進展算術(shù)或者位運算.........................104

2.30、表達式的值在任何求值順序下應(yīng)保持一致.......................105

文件編號

?的深圳市德卡科技

文件版本A1

生效日期發(fā)行類別■新增口修訂

軟件設(shè)計標準

發(fā)行部門研發(fā)中心

2.31、應(yīng)應(yīng)防防止止除除數(shù)數(shù)可可能能為為。。的的情情況況出出現(xiàn)現(xiàn)................................................................110055

2.32、賦值運算符的左操作數(shù)不應(yīng)進展轉(zhuǎn)換操作，并且應(yīng)該是一個可更改的對象105

2.33、sizeof操作符不應(yīng)用在有單邊作用的表達式上.....................105

2.34、