c代碼審查表（條款解釋）

1、C代碼審查表代碼審查表（條款解釋）（條款解釋）一、一、文檔說明文檔說明此文件為廣州高科通信設(shè)備有限公司《C代碼檢查表(修訂)》的條款解釋文件，用于在QC代碼檢查中配合《C代碼檢查表》使用。如果此文件與其它相關(guān)文件發(fā)生沖突或是其它未盡事宜，以公司文件《GKRU038軟件設(shè)計C.C編碼暫行規(guī)定》為準(zhǔn)。二、二、C代碼審查表條款解釋代碼審查表條款解釋1、文件結(jié)構(gòu)文件結(jié)構(gòu)1.1頭文件和定義文件的名稱是否合理？（1）符合基本的命名規(guī)則，用相應(yīng)的英文

2、進行命名，不應(yīng)該出現(xiàn)僅靠大小寫區(qū)分的相似的文件名；（2）當(dāng)某一頭文件僅被一個定義文件引用時，比如某些驅(qū)動程序，兩文件名應(yīng)該有明確的關(guān)聯(lián)性，例如“drv_21Q50.c“和”drv_21Q50.h“。1.2頭文件和定義文件的目錄結(jié)構(gòu)是否合理？（1）當(dāng)一個軟件的頭文件數(shù)目比較多，應(yīng)將頭文件和定義文件分別保存于不同的目錄，以便于維護。如可將頭文件保存于include目錄，將定義文件保存于source目錄。（2）如果某些頭文件是私有的，它不會被

3、用戶的程序直接引用，則沒有必要公開其“聲明”。為了加強信息隱藏，這些私有的頭文件可以和定義文件存放于同一個目錄。1.3版權(quán)和版本聲明是否完整？是否符合標(biāo)準(zhǔn)規(guī)定？版權(quán)和版本的聲明位于頭文件和定義文件的開頭，主要內(nèi)容有：（1）版權(quán)信息。（2）文件名稱，標(biāo)識符，摘要。（3）當(dāng)前版本號，作者修改者，完成日期。（4）版本歷史信息。例如：memy.cxdrroutinefcodingdecodingWDBmemystructuresCopyrigh

4、t19982002GuangZhouGaoKeCommunicationCo.Ltd.modificationhisty01e30jan96elpaddedwindll.hchangedxdr_TGT_ADDR_Tinmacro.01d10jun95padIncludedrpcrpc.h01a03oct94tprwritten.asWanConf[10].abIPLocal[0]=0x8a2.4長行拆分是否得體？（1）代碼行最大長度宜控

5、制在70至80個字符以內(nèi)。標(biāo)準(zhǔn)顯示器輸出設(shè)備（字符終端，缺省寬度的顯示窗口）的寬度都大于等于80個字符，控制代碼行的最大長度可以保證代碼在顯示，編輯，打印等情況下都不會發(fā)生因為寬度不夠而折行的現(xiàn)象。（2）長表達式要在低優(yōu)先級操作符處拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要進行適當(dāng)?shù)目s進，使排版整齊，語句可讀。例如if((very_longer_variable1=very_longer_variable12)又如

6、f(very_longer_initializationvery_longer_conditionvery_longer_update)dosomething()2.5“”和“”是否各占一行并且對齊于同一列？（1）程序的分界符‘’和‘’應(yīng)獨占一行并且位于同一列，同時與引用它們的語句左對齊。例外情況：在dowhile循環(huán)中，while緊接著“”且位于同一行；在聯(lián)合、枚舉、結(jié)構(gòu)體定義中，若在定義這些類型同時定義對象，則定義的對象緊接著“”且