09-軟件代碼審查技術(shù)精要課件

軟件代碼審查技術(shù)北京航空航天大學(xué)

可靠性與系統(tǒng)工程學(xué)院內(nèi)容代碼審查的概念代碼審查的規(guī)程代碼審查的檢查單10/5/2023什么是代碼審查？軟件測試靜態(tài)測試動(dòng)態(tài)測試人工檢查自動(dòng)靜態(tài)分析白盒測試黑盒測試審查走查評(píng)審10/5/20231.代碼審查的概念代碼審查是組成審查組，依據(jù)軟件詳細(xì)設(shè)計(jì)文檔，對(duì)照代碼檢查單，逐行檢查軟件編碼中易出現(xiàn)的錯(cuò)誤的方法。

10/5/20232.代碼審查的規(guī)程2.代碼審查的規(guī)程進(jìn)入條件測試內(nèi)容實(shí)施步驟10/5/20232.1進(jìn)入條件軟件代碼無錯(cuò)誤通過編譯；軟件文檔齊備并符合相關(guān)標(biāo)準(zhǔn)規(guī)范，包括：

詳細(xì)設(shè)計(jì)說明；

代碼清單必要時(shí)還應(yīng)包括：

需求規(guī)格說明；

概要設(shè)計(jì)說明；

數(shù)據(jù)字典；

軟/硬件接口說明；代碼靜態(tài)分析報(bào)告；以及上述文檔引用的其他文檔。10/5/2023檢查代碼和設(shè)計(jì)的一致性；檢查代碼的邏輯表達(dá)的正確性；檢查代碼對(duì)標(biāo)準(zhǔn)的遵循、可讀性；檢查代碼結(jié)構(gòu)的合理性。2.2測試內(nèi)容10/5/2023

軟件代碼審查按時(shí)間順序分為：計(jì)劃、提交軟件概述、個(gè)人審查（會(huì)議準(zhǔn)備）、會(huì)議審查、缺陷修改、回歸審查、編寫報(bào)告。

2.3實(shí)施步驟10/5/20231.4.1計(jì)劃1.4.2提交軟件概述1.4.3個(gè)人審查（會(huì)議準(zhǔn)備）1.4.4會(huì)議審查1.4.5缺陷修改1.4.6回歸審查1.4.7編寫報(bào)告

1.4實(shí)施步驟10/5/2023檢查進(jìn)入條件確定審查內(nèi)容確定審查人員確定審查輔助條件進(jìn)度安排分發(fā)審查材料

1)計(jì)劃編寫《代碼審查計(jì)劃》10/5/2023

在個(gè)人審查前，由軟件開發(fā)方以口頭或書面形式提交軟件概述，簡要介紹待審查軟件的基本概況，使審查人員對(duì)軟件有初步的總體了解。

2)提交軟件概述10/5/2023依據(jù)軟件設(shè)計(jì)文檔，參照代碼檢查單檢查是否存在軟件缺陷記錄缺陷的位置、類型、性質(zhì)等信息，填寫個(gè)人審查記錄匯總組內(nèi)各審查人員發(fā)現(xiàn)的軟件缺陷

3)個(gè)人審查(會(huì)議準(zhǔn)備)10/5/2023講解人：逐句講解軟件代碼，并回答審查人員提出的問題；審查人員：提問和質(zhì)疑，努力發(fā)現(xiàn)被審查軟件代碼中的缺陷；記錄人：記錄在審查會(huì)議中發(fā)現(xiàn)的所有軟件缺陷;主持人：主持會(huì)議，保證會(huì)議按計(jì)劃進(jìn)行，并在發(fā)生爭議時(shí)起調(diào)解作用。填寫“軟件代碼審查確認(rèn)缺陷列表”和“軟件代碼審查問題報(bào)告單”4)會(huì)議審查10/5/2023為提高軟件代碼審查效率并保證審查質(zhì)量，對(duì)會(huì)議時(shí)間和參加人數(shù)作如下規(guī)定：（1）每次審查會(huì)的參加人數(shù)至少3人，最多不超過7人；（2）每次審查會(huì)議的時(shí)間至少45分鐘，最長不超過2小時(shí)。10/5/2023HowfastisthecodeInspectionrate?500statements/hourduringoverview125sourcestatement/hourduringindividual

preparation90-125statements/hourcanbeinspectedInspectionisthereforeanexpensiveprocessInspecting500linescostsabout40man/hours

effort=￡2800->￡5.8/perline10/5/2023

對(duì)于確認(rèn)并要求修改的軟件缺陷，由開發(fā)方人員分析缺陷產(chǎn)生的原因，修改相應(yīng)的軟件代碼或文檔，并編寫《軟件代碼審查更改報(bào)告單》。

5)缺陷修改10/5/2023

待所有要求修改的軟件缺陷修改完成后，組織全部或部分代碼的回歸審查,檢查軟件修改是否正確，是否引入新的軟件缺陷?；貧w審查方法與第一次會(huì)議審查方法相同。

6)回歸審查10/5/2023

由主持人確認(rèn)軟件是否滿足通過準(zhǔn)則，并編寫《軟件代碼審查報(bào)告》。7)編寫報(bào)告10/5/2023通過準(zhǔn)則a.充分評(píng)定了全部代碼清單,并且全部編碼標(biāo)準(zhǔn)被遵守;b.代碼準(zhǔn)確地實(shí)現(xiàn)設(shè)計(jì);c.對(duì)缺陷的解釋已列在缺陷報(bào)告上;d.完成并檢驗(yàn)了代碼審查引起的全部修改。10/5/20233.代碼審查的檢查單代碼檢查單（checklist）可追溯性邏輯數(shù)據(jù)接口注釋文檔例外情況處理內(nèi)存其它10/5/2023可追溯性代碼是否遵循詳細(xì)設(shè)計(jì)？代碼是否與需求一致？10/5/2023邏輯賦值順序表示優(yōu)先級(jí)的括號(hào)用法是否正確？y=(a+b)*c;寫成：y=a+b*c;代碼是否依賴賦值順序？

x=3;y=f(x,x++);

10/5/2023控制“if…else”和“switch”使用是否正確清晰？循環(huán)能否結(jié)束?復(fù)合語句是否被正確地用花括號(hào)括起來?Case語句中是否所有可能出現(xiàn)的情況均已考慮?“goto”和“l(fā)abel”是否只有在有恰當(dāng)理由，而且代碼有詳細(xì)注釋的情況下才使用？10/5/2023“if…else”和“switch”使用是否正確清晰？if(r1_count==1)if(r1_temp==0xbb){r1_ok=1;}if(r1_temp==0xaa){r1_count=1;}else{r1_count=0;}if(vb<0)vb=100;//最小表速限制在10010/5/2023禁止對(duì)實(shí)數(shù)類型的量做是否相等的比較如下代碼：

intP=1000; floatd=0.435f; intH=435;if(H==(P*d)){i=1; }else{i=2; }到底走哪個(gè)分支？

走此分支？H=435P*d=1000*0.435=435是否相等？10/5/2023if(DVLvdtZDemand<-50) wf+=200;elseif(DVLvdtZDemand>50) wf-=200;

接收數(shù)據(jù)出錯(cuò)情況下數(shù)控對(duì)流量的跟蹤缺少對(duì)流量的最大、最小值保護(hù)，這樣有出現(xiàn)負(fù)流量的可能。10/5/2023循環(huán)能否結(jié)束?

for(;;){…if(received==0xcc)break;… }10/5/2023復(fù)合語句是否被正確地用花括號(hào)括起來?if(state_1.eof==0&&status.eof==1) { status.eof=0; k=1; }else { status.eof=1; k=0;}10/5/2023switch(month)/*先計(jì)算某月以前月份的總天數(shù)*/{case1:sum=0;break;case2:sum=31;break;case4:sum=90;break;……case12:sum=334;break;}10/5/2023數(shù)據(jù)1.變量變量在使用前是否已初始化？變量類型是否匹配？變量的聲明是否按組劃分為外部和內(nèi)部的？每個(gè)命名是否僅用于一個(gè)用途？intm3_ps;……if(m3_ps>=1250)m3_ps=0;

CharsFlag;IntiTemp;……sFlag=iTemp；

10/5/2023避免局部變量與全局變量同名unsignedintFire_Command;voidstatic_p(void){unsignedintFire_Command;……

Fire_Command=2;}

10/5/20232.常量常量名是否都大寫？常量是否都是通過“#define”定義？用于多個(gè)文件中的常量是否在一個(gè)INCLUDE頭文件中定義？#definePI3.141510/5/20233.指針定義為指針的變量是否作為指針使用（而不是作為整數(shù)）？指針是否初始化？釋放內(nèi)存后是否將指針立即設(shè)置為NULL（或0）（大多數(shù)編譯器釋放內(nèi)存時(shí)不將指針清空）？傳遞指針到另一個(gè)函數(shù)的代碼是否首先檢查了指針的有效性（非零）？通過指針寫入動(dòng)態(tài)分配內(nèi)存的代碼是否首先檢查了指針的有效性（非零）？int*p;*p=100;10/5/20234.其它宏的命名是否都大寫？數(shù)組是否越界（上下界）?unsignedintHistoryRecord[9];……if(stime42>=1800){ HistoryRecord[9]=1; stime42=0}造成了數(shù)組HistoryRecord越界的錯(cuò)誤。10/5/2023接口在所有的函數(shù)及過程調(diào)用中，參數(shù)的個(gè)數(shù)都正確嗎?形參與實(shí)參類型匹配嗎?參數(shù)順序正確否?如果訪問共享內(nèi)存，是否具有相同的共享內(nèi)存結(jié)構(gòu)模式？voidthree_hellos(charc){……}voidmain(void){ floatt=0.3;three_hellos(t);/*調(diào)用此函數(shù)*/}10/5/2023注釋注釋是否與代碼一致？用于理解代碼的注釋是否提供了必要的信息？除最明顯的聲明外，是否所有聲明都有注釋？10/5/2023文檔軟件文檔是否與軟件代碼一致？是否對(duì)數(shù)組和變量的作用進(jìn)行了描述？10/5/2023例外情況處理是否所有可能的錯(cuò)誤情況都已加以考慮?在繼續(xù)函數(shù)調(diào)用后代碼之前是否檢查了其返回值（指示請(qǐng)求成功或失?。?？10/5/2023switch(month)/*先計(jì)算某月以前月份的總天數(shù)*/{case1:sum=0;break;case2:sum=31;break;……case11:sum=304;break;case12:sum=334;break;

default:printf("dataerror");break;}10/5/2023內(nèi)存在向動(dòng)態(tài)分配內(nèi)存寫入之前是否檢查了內(nèi)存申請(qǐng)是否成功？若采用動(dòng)態(tài)分配內(nèi)存，內(nèi)存空間分配是否正確?當(dāng)內(nèi)存空間不再需要時(shí)，是否被明確地釋放?int*p;