3工作指令wi.rd.018技術(shù)本部軟件編程

1、第 1 頁，共 18 頁目的為保證技術(shù)本部編程設(shè)計的正確性，可性，有效性，特編寫；適用范圍本規(guī)定適用于技術(shù)本部自行設(shè)計的的編程管理。職責(zé)研發(fā)負責(zé)的作成、測試的編寫、的自測和的；負責(zé)的審核；分管副總負責(zé)的批準；技術(shù)本部文控中心負責(zé)及相關(guān)文檔的管理；技術(shù)本部及質(zhì)量部負責(zé)的測試；定義-本文特指用于 DVD 機芯的伺服以及 MCU 的源代碼文件、目標代碼文件（升級文件）。編程規(guī)范排版程序塊要采用縮進風(fēng)格編寫，縮進的空格數(shù)為 4 個。相對獨立的程序塊之間、變量說明之后必須加空行。長的語句（80 字符）要分成多行書寫，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進行適當(dāng)?shù)目s進，

2、使排版整齊，語句可讀。循環(huán)、判斷等語句中若有較長的表達式或語句，則要進行適應(yīng)的劃分，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首。若函數(shù)或過程中的參數(shù)較長，則要進行適當(dāng)?shù)膭澐?。不允許把多個短語句寫在一行中，即一行只寫一條語句。制 訂：2006.12.12審核：批 準：批準日期：生效日期：第 2 頁，共 18 頁5.1.7 if、for、do、while、case、switch、default 等語句自占一行，且 if、for、do、while等語句的執(zhí)行語句部分無論多少都要加括號。5.1.8 對齊只使用空格鍵，不使用 TAB 鍵。5.1.9 函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷

3、等語句中的代碼都要采用縮進風(fēng)格，case語句下的情況處理語句也要遵從語句縮進要求。5.1.10 程序塊的分界符（如 C/C+語言的大括號和）應(yīng)各獨占一行并且位于同一列，同時與它們的語句左對齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及 if、for、do、while、switch、case 語句中的程序都要采用如上的縮進方式。5.1.11 在兩個以上的關(guān)鍵字、變量、常量進行對等操作時，它們之間的操作符之前、之后或者前后要加空格；進行非對等操作時，如果是關(guān)系密切的立即操作符（如），后不應(yīng)加空格。5.1.12 一行程序以小于 80 字符為宜，不要寫得過長。5.2 注釋5.2.1 一般情況

4、下，源程序有效注釋量必須在 20以上。5.2.2 說明性文件（如頭文件.h 文件、.inc 文件、.def 文件、編譯說明文件.cfg 等）頭部應(yīng)進行注釋，注釋必須列權(quán)說明、版本號、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡明。5.2.3 源文件頭部應(yīng)進行注釋，列權(quán)說明、版本號、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。5.2.4 函數(shù)頭部應(yīng)進行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系（函數(shù)、表）等。5.2.5邊寫代碼邊注釋，修改代碼同時修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。5

5、.2.6注釋的內(nèi)容要清楚、明了，含義準確，防止注釋二義性。5.2.7避免在注釋中使用縮寫，特別是非常用縮寫。5.2.8注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。第 3 頁，共 18 頁對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在 時都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。數(shù)據(jù)結(jié)構(gòu) (包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注 在此域的右方。

6、全局變量要有較詳細的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項等的說明。注釋與所描述內(nèi)容進行同樣的縮排。將注釋與其上面的代碼用空行隔開。對變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋。對于 switch 語句下的 case 語句，如果因為特殊情況需要處理完一個 case 后進入下一個 case 處理，必須在該 case 語句處理完、下一個 case 語句前加上明確的注釋。避免在一行代碼或表達式的中間注釋。通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確名以及合理地組織代碼的結(jié)構(gòu)，使代碼成自注釋的。在代碼的功能、意圖層次上進行注釋，提供有用、額外的信息。在程序塊的結(jié)束行右

7、方加注釋標記，以表明某程序塊的結(jié)束。注釋格式盡量，建議使用“/* */”。注釋應(yīng)考慮程序易讀及外觀排版的，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利準確的英文表達。標識符命名標識符名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解。命名中若使用特殊約定或縮寫，則要有注釋說明。自己特有名風(fēng)格，要自始至終保持一致，不可來回變化。對于變量命名，取單個字符（如 i、j、k.），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k 作局部循環(huán)變量是允許的。第 4 頁，共 18 頁命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項目中

8、 ，比如采用 UNIX 的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式，用作特殊標識如標識成員變量或全局變量的 m_和 g_，其后加上大小寫混排的方式是允許的。除非必要，不要用數(shù)字或較奇怪的字符來定義標識符。在同一 產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分標識符（變量、結(jié)構(gòu)、函數(shù)及常量） 名，防止編譯、 時產(chǎn)生 。用正確的反義詞組命名具有互斥意義的變量或相 作的函數(shù)等。除了編譯開關(guān)/頭文件等特殊應(yīng)用，應(yīng)避免使用_EX LE_TEST_之類以下劃線開始和結(jié)尾的定義。可讀性注意運算符的優(yōu)先級，并用括號明確表達式的操作順序，避免使用默認優(yōu)先級。避免使用不易理解的數(shù)字，用有意義的標識來替代

9、。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來代替。源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。不要使用難懂的技巧性很高的語句，除非很有必要時。變量、結(jié)構(gòu)去掉沒必要的公共變量。仔細定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。明確公共變量與操作此公共變量的函數(shù)或過程的關(guān)系，如、修改及創(chuàng)建等。當(dāng)向公共變量傳遞數(shù)據(jù)時，要十分，防止賦與不合理的值或越界等現(xiàn)象發(fā)生。防止局部變量與公共變量同名。嚴禁使用初始化的變量作為右值。構(gòu)造僅有一個模塊或函數(shù)可以修改、創(chuàng)建，而其余有關(guān)模塊或函數(shù)只的公共變量，防止多個不同模塊或函數(shù)都可以修改、創(chuàng)建同一公共變量的現(xiàn)象。使用嚴格

10、形式定義的、可移植的數(shù)據(jù)類型，盡量不要使用與具體硬件或環(huán)境關(guān)系密切的變量。第 5 頁， 共 18頁5.5.9結(jié)構(gòu)的功能要單一，是針對一種事務(wù)的抽象。5.5.10不要設(shè)計面面俱到、非常靈活的數(shù)據(jù)結(jié)構(gòu)。5.5.11不同結(jié)構(gòu)間的關(guān)系不要過于復(fù)雜。5.5.12結(jié)構(gòu)中元素的個數(shù)應(yīng)適中。若結(jié)構(gòu)中元素個數(shù)過多可考慮依據(jù)某種原則把元素組成不同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個數(shù)。5.5.13仔細設(shè)計結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間，并減少引起誤用現(xiàn)象。5.5.14結(jié)構(gòu)的設(shè)計要盡量考慮向前兼容和以后的版本升級，并為某些未來可能的應(yīng)用保留余地（如預(yù)留一些空間等）。5.5.15留心具體語言及編

11、譯器處理不同數(shù)據(jù)類型的原則及有關(guān)細節(jié)。5.5.16編程時，要注意數(shù)據(jù)類型的強制轉(zhuǎn)換。5.5.17對編譯系統(tǒng)默認的數(shù)據(jù)類型轉(zhuǎn)換，也要有充分的認識。5.5.18盡量減少沒有必要的數(shù)據(jù)類型默認轉(zhuǎn)換與強制轉(zhuǎn)換。5.5.19合理地設(shè)計數(shù)據(jù)并使用自定義數(shù)據(jù)類型，避免數(shù)據(jù)間進行不必要的類型轉(zhuǎn)換。5.5.20對自定義數(shù)據(jù)類型進行恰當(dāng)命名，使它成為自描述性的，以提高代碼可讀性。注意其命名方式在同一產(chǎn)品中的。5.5.21當(dāng)用于分布式環(huán)境或不同 CPU 間通信環(huán)境的數(shù)據(jù)結(jié)構(gòu)時，必須考慮機器的字節(jié)順序、使用的位域及字節(jié)對齊等問題 。5.6 函數(shù)、過程5.6.1對所調(diào)用函數(shù)的錯誤返回碼要仔細、全面地處理。5.6.2明確

12、函數(shù)功能，精確（而不是近似）地實現(xiàn)函數(shù)設(shè)計。5.6.3編寫可重入函數(shù)時，應(yīng)注意局部變量的使用（如編寫 C/C+語言的可重入函數(shù)時，應(yīng)使用 auto 即缺省態(tài)局部變量或寄存器變量）說明：編寫 C/C+語言的可重入函數(shù)時，不應(yīng)使用 sic 局部變量，否則必須經(jīng)過特殊處理，才能使函數(shù)具有可重入性。5.6.4 編寫可重入函數(shù)時，若使用全局變量，則應(yīng)通過關(guān)中斷、信號量（即 P、V 操作）等對其加以保護。第 6 頁，共 18 頁說明：若對所使用的全局變量不加以保護，則此函數(shù)就不具有可重入性，即當(dāng)多個進程調(diào)用此函數(shù)時，很有可能使有關(guān)全局變量變?yōu)椴豢芍獱顟B(tài)。在同一項目組應(yīng)明確規(guī)定對接口函數(shù)參數(shù)的檢查應(yīng)由函數(shù)的

13、調(diào)用者負責(zé)還是由接口函數(shù)本身負責(zé)，缺省是由函數(shù)調(diào)用者負責(zé)。防止將函數(shù)的參數(shù)作為工作變量。函數(shù)的規(guī)模盡量限制在 200 行以內(nèi)。一個函數(shù)僅完成一件功能。為簡單功能編寫函數(shù)。不要設(shè)計多用途面面俱到的函數(shù)。說明：多功能集于一身的函數(shù)，很可能使函數(shù)的理解、測試、等變得。函數(shù)的功能應(yīng)該是可以的，也就是只要輸入數(shù)據(jù)相同就應(yīng)產(chǎn)生同樣的輸出。說明：帶有“器”的函數(shù)的功能可能是不可的，因為它的輸出可能取決于存儲器（如某標記）的狀態(tài)。這樣的函數(shù)既不易于理解又不利于測試和。在 C/C+語言中，函數(shù)的 sic 局部變量是函數(shù)的器，有可能使函數(shù)的功能不可，然而，當(dāng)某函數(shù)的返回值為指針類型時，則必須是SIC 的局部變量的

14、地址作為返回值，若為 AUTO 類，則返回為錯針。盡量不要編寫依賴于其他函數(shù)實現(xiàn)的函數(shù)。說明：此條為函數(shù)獨立性的基本要求。由于目前大部分高級語言都是結(jié)構(gòu)化的，所以通過具體語言的語法要求與編譯器功能，基本就可以防止這種情況發(fā)生。但在匯編語言中，由于其靈活性，很可能使函數(shù)出現(xiàn)這種情況。避免設(shè)計多參數(shù)函數(shù)，不使用的參數(shù)從接口中去掉。說明：目的減少函數(shù)間接口的復(fù)雜度。非調(diào)度函數(shù)應(yīng)減少或防止控制參數(shù)，盡量只使用數(shù)據(jù)參數(shù)。說明：本建議目的是防止函數(shù)間的控制耦合。調(diào)度函數(shù)是指根據(jù)輸入的消息類型或控制命令，來啟動相應(yīng)的功能實體（即函數(shù)或過程），而本身并不完成具體功能。控制參數(shù)是指改變函數(shù)功能行為的參數(shù)，即函數(shù)

15、要根據(jù)此參數(shù)來決定具體怎樣工作。非調(diào)度函數(shù)的控制參數(shù)增加了函數(shù)間的控制耦合，很可能使函數(shù)間的耦合度增大，并使函數(shù)的功能不唯一。第 7 頁，共 18 頁檢查函數(shù)所有參數(shù)輸入的有效性。檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等。說明：函數(shù)的輸入主要有兩種：一種是參數(shù)輸入；另一種是全局變量、數(shù)據(jù)文件的輸入，即非參數(shù)輸入。函數(shù)在使用輸入之前，應(yīng)進行必要的檢查。函數(shù)名應(yīng)準確描述函數(shù)的功能。使用動賓詞組為執(zhí)行某操作的函數(shù)命名。如果是 OOP 方法，可以只有動詞（名詞是對象本身）。建議避免使用無意義或含義不清的動詞為函數(shù)命名。說明：避免用含義不清的動詞如 pros、handle 等為函數(shù)命名，因

16、為這些動詞并沒有說明要具體做什么。建議函數(shù)的返回值要清楚、明了，讓使用者不容易忽視錯誤情況。說明：函數(shù)的每種出錯返回值的意義要清晰、明了、準確，防止使用者誤用、理解錯誤或忽視錯誤返回碼。除非必要，最好與函數(shù)返回值類型不同的變量，以編譯系統(tǒng)默認的轉(zhuǎn)換方式或強制的轉(zhuǎn)換方式作為返回值返回。讓函數(shù)在調(diào)用點顯得易懂、容易理解。在調(diào)用函數(shù)填寫參數(shù)時，應(yīng)盡量減少沒有必要的默認數(shù)據(jù)類型轉(zhuǎn)換或強制數(shù)據(jù)類型轉(zhuǎn)換。說明：因為數(shù)據(jù)類型轉(zhuǎn)換或多或少存在。避免函數(shù)中不必要語句，防止程序中的代碼。說明：程序中的代碼不僅占用額外的空間，而且還常常影響程序的功能與性能，很可能給程序的測試、等造成不必要的麻煩。防止把沒有關(guān)聯(lián)的語

17、句放到一個函數(shù)中。說明：防止函數(shù)或過程內(nèi)出現(xiàn)隨機內(nèi)聚。隨機內(nèi)聚是指將沒有關(guān)聯(lián)或關(guān)聯(lián)很弱的語句放到同一個函數(shù)或過程中。隨機內(nèi)聚給函數(shù)或過程的、測試及以后的升級等造成了不便，同第 8 頁，共 18 頁時也使函數(shù)或過程的功能不明確。使用隨機內(nèi)聚函數(shù)，常常容易出現(xiàn)在一種應(yīng)用場合需要改進此函數(shù)，而另一種應(yīng)用場合又不允許這種改進，從而陷入困境。在編程時，經(jīng)常遇到在不同函數(shù)中使用相同的代碼，許多開發(fā)都愿把這些代碼提出來，并一個新函數(shù)。若這些代碼關(guān)聯(lián)較大并且是完成一個功能的，那么這種構(gòu)造是合理的，否則這種構(gòu)造將產(chǎn)生隨機內(nèi)聚的函數(shù)。5.6.26 如果多段代碼重復(fù)做同一件事情，那么在函數(shù)的劃分上可能存在問題。說明

18、：若此段代碼各語句之間有實質(zhì)性關(guān)聯(lián)并且是完成同一件功能的，那么可考慮把此段代碼構(gòu)造成一個新的函數(shù)。5.6.27 功能不明確較小的函數(shù)，特別是僅有一個函數(shù)調(diào)用它時，應(yīng)考慮把它合并到函數(shù)中，而不必單獨存在。說明：模塊中函數(shù)劃分的過多，一般會使函數(shù)間的接口變得復(fù)雜。所以過小的函數(shù)，特別是扇入很低的或功能不明確的函數(shù)，不值得單獨存在。5.6.28 設(shè)計高扇入、合理扇出（小于 7）的函數(shù)。說明：扇出是指一個函數(shù)直接調(diào)用（控制）其它函數(shù)的數(shù)目，而扇入是指有多少函數(shù)調(diào)用它。扇出過大，表明函數(shù)過分復(fù)雜，需要控制和協(xié)調(diào)過多的下級函數(shù)；而扇出過小，如總是 1，表明函數(shù)的調(diào)用層次可能過多，這樣不利程序閱讀和函數(shù)結(jié)構(gòu)

19、的分析，并且程序運行時會對系統(tǒng)資源如堆?？臻g等造成壓力。函數(shù)較合理的扇出（調(diào)度函數(shù)除外）通常是 3-5。扇出太大，一般是由于缺乏中間層次，可適當(dāng)增加中間層次的函數(shù)。扇出太小，可把下級函數(shù)進一步分解多個函數(shù)，或合并到函數(shù)中。當(dāng)然分解或合并函數(shù)時，不能改變要實現(xiàn)的功能，也不能違背函數(shù)間的獨立性。扇入越大，表明使用此函數(shù)的函數(shù)越多，這樣的函數(shù)使用效率高，但不能違背函數(shù)間的獨立性而單純地追求高扇入。公共模塊中的函數(shù)及底層函數(shù)應(yīng)該有較高的扇入。較良好的結(jié)構(gòu)通常是頂層函數(shù)的扇出較高，中層函數(shù)的扇出較少，而底層函數(shù)則扇入到公共模塊中。5.6.29 減少函數(shù)本身或函數(shù)間的遞歸調(diào)用。說明：遞歸調(diào)用特別是函數(shù)間的

20、遞歸調(diào)用（如 A-B-C-A），影響程序的可理解性；遞歸調(diào)用第 9 頁，共 18 頁一般都占用較多的系統(tǒng)資源（如棧空間）；遞歸調(diào)用對程序的測試有一定影響。故除非為某些算法或功能的實現(xiàn)方便，應(yīng)減少沒必要的遞歸調(diào)用。仔細分析模塊的功能及性能需求，并進一步細分，同時若有必要畫出有關(guān)數(shù)據(jù)流圖，據(jù)此來進行模塊的函數(shù)劃分與組織。說明：函數(shù)的劃分與組織是模塊的實現(xiàn)過程中很關(guān)鍵的步驟，如何劃分出合理的函數(shù)結(jié)構(gòu)，關(guān)系到模塊的最終效率和可 性、可測性等。根據(jù)模塊的功能圖或/及數(shù)據(jù)流圖 出函數(shù)結(jié)構(gòu)是常用方法之一。改進模塊中函數(shù)的結(jié)構(gòu)，降低函數(shù)間的耦合度，并提高函數(shù)的獨立性以及代碼可讀性、效率和可 性。優(yōu)化函數(shù)結(jié)構(gòu)時

21、，要遵守以下原則：不能影響模塊功能的實現(xiàn)。仔細考查模塊或函數(shù)出錯處理及模塊的性能要求并進行完善。通過分解或合并函數(shù)來改進結(jié)構(gòu)。考查函數(shù)的規(guī)模，過大的要進行分解。降低函數(shù)間接口的復(fù)雜度。不同層次的函數(shù)調(diào)用要有較合理的扇入、扇出。函數(shù)功能應(yīng)可。提高函數(shù)內(nèi)聚。（單能的函數(shù)內(nèi)聚最高）說明：對初步劃分后的函數(shù)結(jié)構(gòu)應(yīng)進行改進、優(yōu)化，使之更為合理。在多任務(wù)操作系統(tǒng)的環(huán)境下編程，要注意函數(shù)可重入性的構(gòu)造。說明：可重入性是指函數(shù)可以被多個任務(wù)進程調(diào)用。在多任務(wù)操作系統(tǒng)中，函數(shù)是否具有可重入性是非常重要的，因為這是多個進程可以共用此函數(shù)的必要條件。另外，編譯器是否提供可重入函數(shù)庫，與它所服務(wù)的操作系統(tǒng)有關(guān)，只有操

22、作系統(tǒng)是多任務(wù)時，編譯器才有可能提供可重入函數(shù)庫。如 DOS 下 BC 和 MSC 等就不具備可重入函數(shù)庫，因為 DOS 是單用戶單任務(wù)操作系統(tǒng)。避免使用 BOOL 參數(shù)。說明：原因有二，其一是 BOOL 參數(shù)值無意義，TURE/FALSE 的含義是非常模糊的，在調(diào)用時很難知道該參數(shù)到底傳達的是什么意思；其二是 BOOL 參數(shù)值不利于擴充。還有 NULL 也是一個無意義的單詞。第 10 頁，共 18 頁對于提供了返回值的函數(shù)，在時最好使用其返回值。當(dāng)一個過程（函數(shù)）中對較長變量（一般是結(jié)構(gòu)的成員）有較多時，可以用一個意義相當(dāng)?shù)暮甏妗Ｕf明：這樣可以增加編程效率和程序的可讀性?？蓽y性在同一項目組

23、或產(chǎn)品組內(nèi)，要有一套的為集成測試與系統(tǒng)聯(lián)調(diào)準備的調(diào)測開關(guān)及相應(yīng)打印函數(shù)，并且要有詳細的說明。說明：本規(guī)則是針對項目組或產(chǎn)品組的。在同一項目組或產(chǎn)品組內(nèi)，調(diào)測打印出的信息串的格式要有的形式。信息串中至少要有所在模塊名（或源文件名）及行號。說明：的調(diào)測信息格式便于集成測試。編程的同時要為單元測試選擇恰當(dāng)?shù)臏y試點，并仔細構(gòu)造測試代碼、測試用例，同時給出明確的注釋說明。測試代碼部分應(yīng)作為（模塊中的）一個子模塊，以方便測試代碼在模塊中的安裝與拆卸（通過調(diào)測開關(guān)）。說明：為單元測試而準備。在進行集成測試/系統(tǒng)聯(lián)調(diào)之前，要構(gòu)造好測試環(huán)境、測試項目及測試用例，同時仔細分析并優(yōu)化測試用例，以提高測試效率。說明：

24、好的測試用例應(yīng)盡可能模擬出程序所遇到的邊界值、各種復(fù)雜環(huán)境及一些情況等。使用斷言來發(fā)現(xiàn) 問題，提高代碼可測性。說明：斷言是對某種假設(shè)條件進行檢查（可理解為若條件成立則無動作，否則應(yīng) ），它可以快速發(fā)現(xiàn)并定位 問題，同時對系統(tǒng)錯誤進行自動 。斷言可以對在系統(tǒng)中隱藏很深，用其它 極難發(fā)現(xiàn) 進行定位，從而縮短 問題定位時間，提高系統(tǒng)的可測性。實際應(yīng)用時，可根據(jù)具體情況靈活地設(shè)計斷言。用斷言來檢查程序正常運行時不應(yīng)發(fā)生但在調(diào)測時有可能發(fā)生的 情況。不能用斷言來檢查最終產(chǎn)品肯定會出現(xiàn)且必須處理的錯誤情況。說明：斷言是用來處理不應(yīng)該發(fā)生的錯誤情況的，對于可能會發(fā)生的且必須處理的情況要寫防錯程序，而不是斷言

25、。如某模塊收到其它模塊或鏈 的消息后，要對消息的合理性進第 11 頁，共 18 頁行檢查，此過程為正常的錯誤檢查，不能用斷言來實現(xiàn)。5.7.8 對較復(fù)雜的斷言加上明確的注釋。說明：為復(fù)雜的斷言加注釋，可澄清斷言含義并減少不必要的誤用。5.7.9 用斷言確認函數(shù)的參數(shù)。5.7.10 用斷言保證沒有定義的特性或功能不被使用。5.7.11 用斷言對程序開發(fā)環(huán)境（piler/Hardware）的假設(shè)進行檢查。說明：程序運行時所需的軟硬件環(huán)境及配置要求，不能用斷言來檢查，而必須由一段專門代碼處理。用斷言僅可對程序開發(fā)環(huán)境中的假設(shè)及所配置的某版本軟硬件是否具有某種功能的假設(shè)進行檢查。如某網(wǎng)卡是否在系統(tǒng)運行

26、環(huán)境中配置了，應(yīng)由程序中正式代碼來檢查；而此網(wǎng)卡是否具有某設(shè)想的功能，則可由斷言來檢查。對編譯器提供的功能及特性假設(shè)可用斷言檢查，原因是最終產(chǎn)品（即運行代碼或機器碼）與編譯器已沒有任何直接關(guān)系，即運行過程中（注意不是編譯過程中）不會也不應(yīng)該對編譯器的功能提出任何需求。5.7.12 正式產(chǎn)品中應(yīng)把斷言及其它調(diào)測代碼去掉（即把有關(guān)的調(diào)測開關(guān)關(guān)掉）。說明：加快運行速度。5.7.13 在系統(tǒng)中設(shè)置與取消有關(guān)測試，不能對實現(xiàn)的功能等產(chǎn)生影響。說明：即有測試代碼的關(guān)掉測試代碼的，在功能行為上應(yīng)一致。5.7.14用調(diào)測開關(guān)來切換的 DEBUG 版和正式版，而不要同時存在正式版本和 DEBUG 版本的不同源文

27、件，以減少的難度。5.7.15的 DEBUG 版本和版本應(yīng)該，不允許分家，并且要時刻注意保證兩個版本在實現(xiàn)功能上的一致性。5.7.16在編寫代碼之前，應(yīng)預(yù)先設(shè)計好程序調(diào)試與測試的方法和，并設(shè)計好各種調(diào)測開關(guān)及相應(yīng)測試代碼如打印函數(shù)等。說明：程序的調(diào)試與測試是生存周期中很重要的一個階段，如何對進行較全面、高率測試并盡可能地找出中的錯誤就成為很關(guān)鍵。因此在編寫源代碼之前，除了要有一套比較完善的測試計劃外，還應(yīng)設(shè)計出一系列代碼測試，為單元測試、集成測試及系統(tǒng)聯(lián)調(diào)提供方便。第 12 頁，共 18 頁調(diào)測開關(guān)應(yīng)分為不同級別和類型。說明： 調(diào)測開關(guān)的設(shè)置及分類應(yīng)從以下幾方面考慮：針對模塊或系統(tǒng)某部分代碼的

28、調(diào)測；針對模塊或系統(tǒng)某功能的調(diào)測；出于某種其它目的，如對性能、容量等的測試。這樣做便于功能的調(diào)測，并且便于模塊的單元測試、系統(tǒng)聯(lián)調(diào)等。編寫防錯程序，然后在處理錯誤之后可用斷言宣布發(fā)生錯誤。程序效率編程時要經(jīng)常注意代碼的效率。說 碼效率分為全局效率、局部效率、時間效率及空間效率。全局效率是站在整個系統(tǒng)的角度上的系統(tǒng)效率；局部效率是站在模塊或函數(shù)角度上的效率；時間效率是程序處理輸入任務(wù)所需的時間長短；空間效率是程序所需內(nèi)存空間，如機器代碼空間大小、數(shù)據(jù)空間大小、?？臻g大小等。在保證 系統(tǒng)的正確性、穩(wěn)定性、可讀性及可測性的前提下，提高代碼效率。說明：不能一味地追求代碼效率，而對的正確性、穩(wěn)定性、可讀

29、性及可測性造成影響。局部效率應(yīng)為全局效率服務(wù)，不能因為提高局部效率而對全局效率造成影響。通過對系統(tǒng)數(shù)據(jù)結(jié)構(gòu)的劃分與組織的改進，以及對程序算法的優(yōu)化來提高空間效率。說明：這種方式是解決空間效率的根本辦法。循環(huán)體內(nèi)工作量最小化。說明：應(yīng)仔細考慮循環(huán)體內(nèi)的語句是否可以放在循環(huán)體之外，使循環(huán)體內(nèi)工作量最小，從而提高程序的時間效率。仔細分析有關(guān)算法，并進行優(yōu)化。仔細考查、分析系統(tǒng)及模塊處理輸入（如事務(wù)、消息等）的方式，并加以改進。對模塊中函數(shù)的劃分及組織方式進行分析、優(yōu)化，改進模塊中函數(shù)的組織結(jié)構(gòu)，提高程序效率。說明：系統(tǒng)的效率主要與算法、處理任務(wù)方式、系統(tǒng)功能及函數(shù)結(jié)構(gòu)有很大關(guān)系，僅在代碼上下功夫一般

30、不能解決根本問題。編程時，要隨時留心代碼效率；優(yōu)化代碼時，要考慮。不應(yīng)花過多的時間拼命地提高調(diào)用不很頻繁的函數(shù)代碼效率。第 13 頁，共 18 頁說明：對代碼優(yōu)化可提高效率，但若考慮不周很有可能引起嚴重。要仔細地構(gòu)造或直接用匯編編寫調(diào)用頻繁或性能要求極高的函數(shù)。說明：只有對編譯系統(tǒng)產(chǎn)生機器碼的方式以及硬件系統(tǒng)較為熟悉時，才可使用匯編嵌入方式。嵌入?yún)R編可提高時間及空間效率，但也存在一定風(fēng)險。在保證程序質(zhì)量的前提下，通過壓縮代碼量、去掉不必要代碼以及減少不必要的局部和全局變量，來提高空間效率。說明：這種方式對提高空間效率可起到一定作用，但往往不能解決根本問題。在多重循環(huán)中，應(yīng)將最忙的循環(huán)放在最內(nèi)層

31、。說明：減少 CPU 切入循環(huán)層的次數(shù)。盡量減少循環(huán)嵌套層次。避免循環(huán)體內(nèi)含判斷語句，應(yīng)將循環(huán)語句置于判斷語句的代碼塊之中。說明：目的是減少判斷次數(shù)。循環(huán)體中的判斷語句是否可以移到循環(huán)體外，要視程序的具體情況而言，一般情況，與循環(huán)變量無關(guān)的判斷語句可以移到循環(huán)體外，而有關(guān)的則不可以。盡量用乘法或其它方法代替除法，特別是浮點運算中的除法。說明：浮點運算除法要占用較多 CPU 資源。不要一味追求緊湊的代碼。說明：因為緊湊的代碼并不代表高效的機器碼。質(zhì)量保證在設(shè)計過程中構(gòu)筑質(zhì)代碼質(zhì)量保證優(yōu)先原則正確性，指程序要實現(xiàn)設(shè)計要求的功能。穩(wěn)定性、安全性，指程序穩(wěn)定、可靠、安全?？蓽y試性，指程序要具有良好的可

32、測試性。規(guī)范/可讀性，指程序書寫風(fēng)格、命名規(guī)則等要符合規(guī)范。全局效率，指系統(tǒng)的整體效率。局部效率，指某個模塊/子模塊/函數(shù)的本身效率。個人表達方式/個人方便性，指個人編程。第 14 頁，共 18 頁5.9.3 只屬于自己的存貯空間。說明：若模塊封裝的較好，那么一般不會發(fā)生他人的空間。5.9.4 防止已經(jīng)的內(nèi)存空間。說明：在實際編程過程中，稍不留心就會出現(xiàn)在一個模塊中了某個內(nèi)存塊（如 C 語言指針），而另一模塊在隨后的某個時刻又使用了它。要防止這種情況發(fā)生。5.9.5 過程/函數(shù)中分配的內(nèi)存，在過程/函數(shù)退出之前要。5.9.6 過程/函數(shù)中申請的（為打開文件而使用的）文件句柄，在過程/函數(shù)退出之

33、前要關(guān)閉。說明：分配的內(nèi)存不以及文件句柄不關(guān)閉，是較常見的錯誤，而且稍不注意就有可能發(fā)生。這類錯誤往往會引起很嚴重，且難以定位。5.9.7 防止內(nèi)存操作越界。說明：內(nèi)存操作主要是指對數(shù)組、指針、內(nèi)存地址等的操作。內(nèi)存操作越界是系統(tǒng)主要錯誤之一，往往非常嚴重，所以當(dāng)進行這些操作時一定要仔細。5.9.8 認真處理程序所能遇到的各種出錯情況。5.9.9 系統(tǒng)運行之初，要初始化有關(guān)變量及運行環(huán)境，防止初始化的變量被。5.9.10 系統(tǒng)運行之初，要對加載到系統(tǒng)中的數(shù)據(jù)進行一致性檢查。說明：使用不一致的數(shù)據(jù)，容易使系統(tǒng)進入狀態(tài)和不可知狀態(tài)。5.9.11 嚴禁隨意更改其它模塊或系統(tǒng)的有關(guān)設(shè)置和配置。說明：編

34、程時，不能隨心所欲地更改不屬于自己模塊的有關(guān)設(shè)置如常量、數(shù)組的大小等。5.9.12 不能隨意改變與其它模塊的接口。5.9.13 充分了解系統(tǒng)的接口之后，再使用系統(tǒng)提供的功能。5.9.14 編程時，要防止差 1 錯誤。說明：此類錯誤一般是由于把“=”誤寫成“=”誤寫成“”等造成的，由此引起的，很多情況下是很嚴重的，所以編程時，一定要在這些地方。當(dāng)編完程序后，應(yīng)對這些操作符進行徹底檢查。5.9.15 要時刻注意易拼寫錯誤。的操作符。當(dāng)編完程序后，應(yīng)從頭至尾檢查一遍這些操作符，以防止說明：形式相近的操作符最容易引起誤用，如 C/C+中的“=”與“=”、“|”與“|”、“&”與第 15 頁，共 18

35、頁“&”等，若拼寫錯了，編譯器不一定能夠檢查出來。有可能的話，if 語句盡量加上 else 分支，對沒有 else 分支的語句要對待；switch語句必須有 default 分支。Unix 下，多線程的中的子線程退出必需采用主動退出方式，即子線程應(yīng) return 出口。不要goto 語句。說明：goto 語句會破壞程序的結(jié)構(gòu)性，所以除非確實需要，最好不使用 goto 語句。不使用與硬件或操作系統(tǒng)關(guān)系很大的語句，而使用建議的標準語句，以提高的可移植性和可重用性。除非為了滿足特殊需求，避免使用匯編。說明：程序中匯編，一般都對可移植性有較大的影響。精心地構(gòu)造、劃分子模塊，并按“接口”部分及“內(nèi)核”部

36、分合理地組織子模塊，以提高“內(nèi)核”部分的可移植性和可重用性。說明：對不同產(chǎn)品中的某個功能相同的模塊，若能做到其內(nèi)核部分完全或基本一致，那么無論對產(chǎn)品的測試、，還是對以后產(chǎn)品的升級都會有很大幫助。精心構(gòu)造算法，并對其性能、效率進試。對較關(guān)鍵的算法最好使用其它算法來確認。時刻注意表達式是否會上溢、下溢。使用變量時要注意其邊界值的情況。留心程序機器碼大小（如指令空間大小、數(shù)據(jù)空間大小、堆?？臻g大小等）是否超出系統(tǒng)有關(guān)限制。為用戶提供良好的接口界面，使用戶能較充分地了解系統(tǒng)運行狀態(tài)及有關(guān)系統(tǒng)出錯情況。系統(tǒng)應(yīng)具有一定的容錯能力，對一些錯誤事件（如用戶誤操作等）能進行自動補救。對一些具有性的操作代碼（如寫

37、硬盤、刪數(shù)據(jù)等）要仔細考慮，防止對數(shù)據(jù)、硬件等的安全危害，以提高系統(tǒng)的安全性。使用第提供的開發(fā)工具包或控件時，要注意以下幾點：（1） 充分了解應(yīng)用接口、使用環(huán)境及使用時注意事項。第 16 頁，共 18 頁不能過分相信其正確性。除非必要，不要使用不熟悉的第 工具包與控件。說明：使用工具包與控件，可加快程序開發(fā)速度，節(jié)省時間，但使用之前一定對它有較充分的了解，同時第 工具包與控件也有可能存在問題。5.9.31 資源文件（多語言版本支持），如果資源是對語言敏感的，應(yīng)讓該資源與源代碼文件脫離，具體方法有下面幾種：使用單獨的資源文件、DLL 文件或其它單獨的描述文件（如數(shù)據(jù)庫格式）代碼編輯、編譯、打開編譯器的所有告警開關(guān)對程序進行編譯。在產(chǎn)品 （項目組）中，要 編譯開關(guān)選項。通過代碼走讀及 方式對代碼進行檢查。說 碼走讀主要是對程序的編程風(fēng)格如注釋、命名等以及編程時易出錯的內(nèi)容進行檢查，可由開發(fā) 自己或開發(fā) 交叉的方式進行；代碼 主要是對程序?qū)崿F(xiàn)的功能及程序的穩(wěn)定性、安全性、可靠性等進行檢查及評審，可通過自