【XXXX項(xiàng)目】代碼審查報(bào)告(總4頁)

《【XXXX項(xiàng)目】代碼審查報(bào)告(總4頁)》由會(huì)員分享，可在線閱讀，更多相關(guān)《【XXXX項(xiàng)目】代碼審查報(bào)告(總4頁)（4頁珍藏版）》請(qǐng)?jiān)谘b配圖網(wǎng)上搜索。

1、代碼審查報(bào)告 檢 查 人：________________ 檢查日期：_____年_____月_____日 審查內(nèi)容：__請(qǐng)?zhí)顚憟?zhí)行代碼審查的系統(tǒng)名稱______________________________________ 審查結(jié)果：通過□ 不通過□ 說 明：__請(qǐng)?zhí)顚憟?zhí)行代碼審查的系統(tǒng)功能______________________________________ 總 則 條 款 執(zhí)行情況 說明 1 排版 1-1：程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)由4個(gè)空格組成。 是[ ] 否[ ] 免[ ] 1-2：相對(duì)獨(dú)立的程序塊之間、變量說明

2、之后必須加空行。 是[ ] 否[ ] 免[ ] 1-3：較長的語句（>80字符）要分成多行書寫，長表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語句可讀。 是[ ] 否[ ] 免[ ] 1-4：循環(huán)、判斷等語句中若有較長的表達(dá)式或語句，則要進(jìn)行適應(yīng)的劃分，長表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。 是[ ] 否[ ] 免[ ] 1-5：若函數(shù)或過程中的參數(shù)較長，則要進(jìn)行適當(dāng)?shù)膭澐帧? 是[ ] 否[ ] 免[ ] 1-6：不允許把多個(gè)短語句寫

3、在一行中，即一行只寫一條語句。 是[ ] 否[ ] 免[ ] 1-7：if、while、for、default、do等語句自占一行。 是[ ] 否[ ] 免[ ] 1-8：對(duì)齊只使用TAB鍵，不使用空格鍵。 是[ ] 否[ ] 免[ ] 1-9：函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進(jìn)風(fēng)格，case語句下的情況處理語句也要遵從語句縮進(jìn)要求。 是[ ] 否[ ] 免[ ] 1-10：程序塊的分界符（如C/C++語言的大括號(hào)‘{’和‘}’）應(yīng)各獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語

4、句左對(duì)齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case語句中的程序都要采用如上的縮進(jìn)方式。 是[ ] 否[ ] 免[ ] 1-11：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符（如－>），后不應(yīng)加空格。 是[ ] 否[ ] 免[ ] 2 注釋 2-1：一般情況下，源程序有效注釋量必須在20％以上。 是[ ] 否[ ] 免[ ] 2-2：說明性文件（如頭文件.h文件、.inc文件、

5、.def文件、編譯說明文件.cfg等）頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡要說明。 是[ ] 否[ ] 免[ ] 2-3：源文件頭部應(yīng)進(jìn)行注釋，列出：版權(quán)說明、版本號(hào)、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。 是[ ] 否[ ] 免[ ] 2-4：函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系（函數(shù)、表）等。 是[ ] 否[ ] 免[ ] 2-5：邊寫代碼邊注釋，修改代碼同時(shí)修改相

6、應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除。 是[ ] 否[ ] 免[ ] 2-6：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。 是[ ] 否[ ] 免[ ] 2-7：避免在注釋中使用縮寫，特別是非常用縮寫。 是[ ] 否[ ] 免[ ] 2-8：注釋應(yīng)與其描述的代碼相近，對(duì)代碼的注釋應(yīng)放在其上方或右方（對(duì)單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。 是[ ] 否[ ] 免[ ] 2-9：對(duì)于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必

7、須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。 是[ ] 否[ ] 免[ ] 2-10：數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋放在此域的右方。 是[ ] 否[ ] 免[ ] 2-11：全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時(shí)注意事項(xiàng)等的說明。 是[ ] 否[ ] 免[ ] 2-12：注釋與所描述內(nèi)容進(jìn)行同樣的縮排。 是[ ] 否[ ]

8、免[ ] 2-13：將注釋與其上面的代碼用空行隔開。 是[ ] 否[ ] 免[ ] 2-14：對(duì)變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋。 是[ ] 否[ ] 免[ ] 2-15：對(duì)于switch語句下的case語句，如果因?yàn)樘厥馇闆r需要處理完一個(gè)case后進(jìn)入下一個(gè)case處理，必須在該case語句處理完、下一個(gè)case語句前加上明確的注釋。 是[ ] 否[ ] 免[ ] 3 標(biāo)識(shí)符命名 3-1：標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解。 是[

9、 ] 否[ ] 免[ ] 3-2：命名中若使用特殊約定或縮寫，則要有注釋說明。 是[ ] 否[ ] 免[ ] 3-3：自己特有的命名風(fēng)格，要自始至終保持一致，不可來回變化。 是[ ] 否[ ] 免[ ] 3-4：對(duì)于變量命名，禁止取單個(gè)字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。 是[ ] 否[ ] 免[ ] 3-5：命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一，比如采用UNIX的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大

10、小寫與下劃線混排的方式。 是[ ] 否[ ] 免[ ] 4 可讀性 4-1：注意運(yùn)算符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí)。 是[ ] 否[ ] 免[ ] 4-2：避免使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來替代。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來代替。 是[ ] 否[ ] 免[ ] 5-1：去掉沒必要的公共變量。 是[ ] 否[ ] 免[ ] 5-2：仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。 5-3：明確公共變量與

11、操作此公共變量的函數(shù)或過程的關(guān)系，如訪問、修改及創(chuàng)建等。 5-4：當(dāng)向公共變量傳遞數(shù)據(jù)時(shí)，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生。 5-5：防止局部變量與公共變量同名。 5-6：嚴(yán)禁使用未經(jīng)初始化的變量作為右值。 6 函數(shù)、過程 6-1：對(duì)所調(diào)用函數(shù)的錯(cuò)誤返回碼要仔細(xì)、全面地處理。 是[ ] 否[ ] 免[ ] 6-2：明確函數(shù)功能，精確（而不是近似）地實(shí)現(xiàn)函數(shù)設(shè)計(jì)。 是[ ] 否[ ] 免[ ] 6-3：編寫可重入函數(shù)時(shí)，應(yīng)注意局部變量的使用(如編寫C/C++語言的可重入函數(shù)時(shí)，應(yīng)使用auto即

12、缺省態(tài)局部變量或寄存器變量)。 是[ ] 否[ ] 免[ ] 6-4：編寫可重入函數(shù)時(shí)，若使用全局變量，則應(yīng)通過關(guān)中斷、信號(hào)量（即P、V操作）等手段對(duì)其加以保護(hù)。 是[ ] 否[ ] 免[ ] 7 可測(cè)性 7-1：在同一項(xiàng)目組或產(chǎn)品組內(nèi)，要有一套統(tǒng)一的為集成測(cè)試與系統(tǒng)聯(lián)調(diào)準(zhǔn)備的調(diào)測(cè)開關(guān)及相應(yīng)打印函數(shù)，并且要有詳細(xì)的說明。 是[ ] 否[ ] 免[ ] 7-2：在同一項(xiàng)目組或產(chǎn)品組內(nèi)，調(diào)測(cè)打印出的信息串的格式要有統(tǒng)一的形式。信息串中至少要有所在模塊名（或源文件名）及行號(hào)。 是[ ] 否[ ] 免[ ] 7-3：編程

13、的同時(shí)要為單元測(cè)試選擇恰當(dāng)?shù)臏y(cè)試點(diǎn)，并仔細(xì)構(gòu)造測(cè)試代碼、測(cè)試用例，同時(shí)給出明確的注釋說明。測(cè)試代碼部分應(yīng)作為（模塊中的）一個(gè)子模塊，以方便測(cè)試代碼在模塊中的安裝與拆卸（通過調(diào)測(cè)開關(guān)）。 是[ ] 否[ ] 免[ ] 7-4：在進(jìn)行集成測(cè)試/系統(tǒng)聯(lián)調(diào)之前，要構(gòu)造好測(cè)試環(huán)境、測(cè)試項(xiàng)目及測(cè)試用例，同時(shí)仔細(xì)分析并優(yōu)化測(cè)試用例，以提高測(cè)試效率。 是[ ] 否[ ] 免[ ] 7-5：使用斷言來發(fā)現(xiàn)軟件問題，提高代碼可測(cè)性。 是[ ] 否[ ] 免[ ] 7-6：用斷言來檢查程序正常運(yùn)行時(shí)不應(yīng)發(fā)生但在調(diào)測(cè)時(shí)有可能發(fā)生的非法情況。 是[ ]

14、否[ ] 免[ ] 7-7：不能用斷言來檢查最終產(chǎn)品肯定會(huì)出現(xiàn)且必須處理的錯(cuò)誤情況。 是[ ] 否[ ] 免[ ] 7-8：對(duì)較復(fù)雜的斷言加上明確的注釋。 是[ ] 否[ ] 免[ ] 7-9：用斷言確認(rèn)函數(shù)的參數(shù)。 是[ ] 否[ ] 免[ ] 7-10：用斷言保證沒有定義的特性或功能不被使用。 是[ ] 否[ ] 免[ ] 7-11：用斷言對(duì)程序開發(fā)環(huán)境（OS/Compiler/Hardware）的假設(shè)進(jìn)行檢查。 是[ ] 否[ ] 免[ ] 7-12：正式軟件產(chǎn)品中應(yīng)把斷言及

15、其它調(diào)測(cè)代碼去掉（即把有關(guān)的調(diào)測(cè)開關(guān)關(guān)掉）。 是[ ] 否[ ] 免[ ] 7-13：在軟件系統(tǒng)中設(shè)置與取消有關(guān)測(cè)試手段，不能對(duì)軟件實(shí)現(xiàn)的功能等產(chǎn)生影響。 是[ ] 否[ ] 免[ ] 7-14：用調(diào)測(cè)開關(guān)來切換軟件的DEBUG版和正式版，而不要同時(shí)存在正式版本和DEBUG版本的不同源文件，以減少維護(hù)的難度。 是[ ] 否[ ] 免[ ] 7-15：軟件的DEBUG版本和發(fā)行版本應(yīng)該統(tǒng)一維護(hù)，不允許分家，并且要時(shí)刻注意保證兩個(gè)版本在實(shí)現(xiàn)功能上的一致性。 是[ ] 否[ ] 免[ ] 8 程序效率 8-1：編程時(shí)要

16、經(jīng)常注意代碼的效率。 是[ ] 否[ ] 免[ ] 8-2：在保證軟件系統(tǒng)的正確性、穩(wěn)定性、可讀性及可測(cè)性的前提下，提高代碼效率。 是[ ] 否[ ] 免[ ] 8-3：局部效率應(yīng)為全局效率服務(wù)，不能因?yàn)樘岣呔植啃识鴮?duì)全局效率造成影響。 是[ ] 否[ ] 免[ ] 8-4：通過對(duì)系統(tǒng)數(shù)據(jù)結(jié)構(gòu)的劃分與組織的改進(jìn)，以及對(duì)程序算法的優(yōu)化來提高空間效率。 是[ ] 否[ ] 免[ ] 8-5：循環(huán)體內(nèi)工作量最小化。 是[ ] 否[ ] 免[ ] 9 質(zhì)量保證 9-1：在軟件設(shè)計(jì)過程中構(gòu)筑軟件質(zhì)量。

17、 是[ ] 否[ ] 免[ ] 9-2：代碼質(zhì)量保證優(yōu)先原則 是[ ] 否[ ] 免[ ] 9-3：只引用屬于自己的存貯空間。 是[ ] 否[ ] 免[ ] 9-4：防止引用已經(jīng)釋放的內(nèi)存空間。 是[ ] 否[ ] 免[ ] 9-5：過程/函數(shù)中分配的內(nèi)存，在過程/函數(shù)退出之前要釋放。 是[ ] 否[ ] 免[ ] 9-6：過程/函數(shù)中申請(qǐng)的(為打開文件而使用的)文件句柄，在過程/函數(shù)退出之前要關(guān)閉。 是[ ] 否[ ] 免[ ] 9-7：防止內(nèi)存操作越界。 是[ ]

18、否[ ] 免[ ] 9-8：認(rèn)真處理程序所能遇到的各種出錯(cuò)情況。 是[ ] 否[ ] 免[ ] 9-9：系統(tǒng)運(yùn)行之初，要初始化有關(guān)變量及運(yùn)行環(huán)境，防止未經(jīng)初始化的變量被引用。 是[ ] 否[ ] 免[ ] 9-10：系統(tǒng)運(yùn)行之初，要對(duì)加載到系統(tǒng)中的數(shù)據(jù)進(jìn)行一致性檢查。 是[ ] 否[ ] 免[ ] 9-11：嚴(yán)禁隨意更改其它模塊或系統(tǒng)的有關(guān)設(shè)置和配置。 是[ ] 否[ ] 免[ ] 9-12：不能隨意改變與其它模塊的接口。 是[ ] 否[ ] 免[ ] 9-13：充分了解系統(tǒng)的接口之后，再使用系統(tǒng)提供的功能。 是[ ] 否[ ] 免[ ] 9-14：編程時(shí)，要防止差1錯(cuò)誤。 是[ ] 否[ ] 免[ ] 9-15：要時(shí)刻注意易混淆的操作符。當(dāng)編完程序后，應(yīng)從頭至尾檢查一遍這些操作符，以防止拼寫錯(cuò)誤。 是[ ] 否[ ] 免[ ] 9-16：有可能的話，if語句盡量加上else分支，對(duì)沒有else分支的語句要小心對(duì)待；switch語句必須有default分支。 是[ ] 否[ ] 免[ ]