下載本文檔
版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進(jìn)行舉報(bào)或認(rèn)領(lǐng)
文檔簡介
1、代碼審閱報(bào)告檢驗(yàn)員:_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _檢查日期:_ _ _ _ _ _ _ _ _月_ _ _ _ _日審閱內(nèi)容:執(zhí)行_ _代碼審閱的系統(tǒng)名稱_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _審查結(jié)果:通過未通過說明:_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ u總則執(zhí)行情況說明第一排1-1:程序塊必須以縮進(jìn)樣式編寫,縮進(jìn)由4個(gè)空格組成。是否免費(fèi)1-2:在相對獨(dú)立的程序塊之間,應(yīng)在變量
2、說明后添加空行。是否免費(fèi)1-3:長語句(80個(gè)字符)要分成多行寫,長表達(dá)式要由低優(yōu)先級運(yùn)算符分新行寫,運(yùn)算符放在新行的開頭,分的新行要適當(dāng)?shù)乜s進(jìn),排版要整齊,語句要可讀。是否免費(fèi)1-4:在循環(huán)、判斷等語句中,如果有較長的表達(dá)式或語句,則將其有效地拆分,較長的表達(dá)式從低優(yōu)先級運(yùn)算符拆分新行,運(yùn)算符位于新行的開頭。是否免費(fèi)1-5:如果函數(shù)或進(jìn)程的參數(shù)很長,則進(jìn)行相應(yīng)的劃分。是否免費(fèi)1-6:一行不能寫幾個(gè)短語句。也就是說,每行不能只寫一個(gè)語句。是否免費(fèi)1-7: if、while、for、default、do等語句從一行開始。是否免費(fèi)1-8:僅使用TAB鍵進(jìn)行排序,不使用空格鍵。是否免費(fèi)1-9:函數(shù)或
3、過程的開始、結(jié)構(gòu)定義和循環(huán)、判斷等語句中的代碼必須采用縮進(jìn)格式,對于case語句,必須遵循語句的縮進(jìn)要求。是否免費(fèi)1-10:程序塊中的分界符號(如C/C語言中的花括號“”和“”)必須單獨(dú)位于同一列中(每行一個(gè)),并與引用它們的語句左對齊。函數(shù)體開始、類定義、結(jié)構(gòu)定義、枚舉定義和if、for、do、while、switch、case語句中的程序?qū)⑷缟纤究s進(jìn)。是否免費(fèi)1-11:當(dāng)兩個(gè)或多個(gè)關(guān)鍵字、變量、常量相等時(shí),在它們之間的運(yùn)算符之前、之后或前后放置空格。執(zhí)行非對等操作時(shí),對于關(guān)系密切的立即操作符(例如-),不應(yīng)在后面加空格。是否免費(fèi)注釋22-1:通常,源程序有效注釋量應(yīng)大于20%。是否免費(fèi)2
4、-2:頭文件。h文件,Inc文件,def文件,編譯說明文件。注釋文件(如CFG)必須注釋頭部,注釋還必須對函數(shù)功能進(jìn)行簡要說明,包括版權(quán)說明、版本號、創(chuàng)建日期、作者、內(nèi)容、功能、與其他文件的關(guān)系、修改日志、標(biāo)題文件的注釋。是否免費(fèi)2-3:源文件的頭應(yīng)包含版權(quán)說明、版本號、創(chuàng)建日期、作者、模塊目的/功能、主要功能和功能、修改日志等注釋。是否免費(fèi)2-4:必須注釋函數(shù)頭,如函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系(函數(shù)、表)等。是否免費(fèi)2-5:創(chuàng)建邊緣注釋,修改代碼,同時(shí)修改相應(yīng)的注釋以確保注釋和代碼的一致性。不再有用的注釋將被刪除。是否免費(fèi)2-6:注釋內(nèi)容要明確、明確、意義正確,防止
5、注釋異議性。是否免費(fèi)2-7:不要在注釋中使用縮寫,尤其是不經(jīng)常使用的縮寫。是否免費(fèi)2-8:注釋應(yīng)類似于所描述的代碼,對代碼的注釋應(yīng)位于其上或右側(cè)(對單個(gè)語句的注釋)旁邊,不應(yīng)位于下面,如果位于上面,則應(yīng)使用上面的代碼和空行分隔。是否免費(fèi)2-9:所有具有物理意義的變量,對于常量,如果其名稱不是完全注釋,那么在聲明時(shí)必須注釋并說明其物理意義。變量、常量、宏的注釋必須位于其上方相鄰的位置或右側(cè)。是否免費(fèi)2-10:數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等),如果其名稱沒有完全自描述,則需要注釋。數(shù)據(jù)結(jié)構(gòu)的注釋必須與其上方相鄰,且不能位于下方。結(jié)構(gòu)中每個(gè)域的說明位于此域的右側(cè)。是否免費(fèi)2-11:全局變量
6、需要更詳細(xì)的說明,包括對其功能、值范圍、要訪問的函數(shù)或進(jìn)程、訪問時(shí)的注意事項(xiàng)等的說明。是否免費(fèi)2-12:說明縮排與說明相同。是否免費(fèi)2-13:用空行分隔注釋及其上方的代碼。是否免費(fèi)2-14:變量的定義和分支語句(條件分支、循環(huán)語句等)需要注釋。是否免費(fèi)2-15:對于switch語句下的case語句,在特殊情況下,必須處理一個(gè)case,然后進(jìn)入下一個(gè)case處理,因此必須處理case語句,并在下一個(gè)case語句之前添加明確的注釋。是否免費(fèi)指定3標(biāo)識符名稱3-1:標(biāo)識符的名稱不僅要有明確、明確、明確的含義,而且要使用整個(gè)單詞或所有人基本都能理解的縮寫,以免引起誤解。是否免費(fèi)3-2:如果命名使用特殊
7、規(guī)則或縮寫,則必須具有備注說明。是否免費(fèi)3-3:自己獨(dú)特的命名風(fēng)格,從頭到尾都要一致,不能前后變更。是否免費(fèi)3-4:對于變量命名,包含單個(gè)字符(例如I,j,k).),除了具體的意義外,還可以表示相應(yīng)的變量類型、數(shù)據(jù)類型等,但是建議將I、j、k用作局部循環(huán)變量。是否免費(fèi)3-5:命名規(guī)范必須與使用的系統(tǒng)樣式相匹配,并在同一項(xiàng)目中統(tǒng)一。例如,在UNIX上,可以將大小寫混合為帶下劃線的樣式或大小寫。不要將大小寫與下劃線混合。是否免費(fèi)4可讀性4-1:注意運(yùn)算符的優(yōu)先級,通過用括號明確表達(dá)式的操作順序,不使用默認(rèn)優(yōu)先級。是否免費(fèi)4-2:避免使用難以理解的數(shù)字,用有意義的標(biāo)志代替。與物理狀態(tài)相關(guān)或包含物理意
8、義的常量不應(yīng)直接使用數(shù)字,而應(yīng)使用有意義的枚舉或宏替換。是否免費(fèi)5-1:刪除不必要的公共變量。是否免費(fèi)5-2:仔細(xì)定義和闡明公用變量的含義、職責(zé)、值范圍和公用變量之間的關(guān)系。5-3:明確操作公共變量的函數(shù)或過程與公共變量的關(guān)系,例如訪問、修改和創(chuàng)建。5-4:將數(shù)據(jù)傳遞到公共變量時(shí),要非常小心,不要發(fā)生不當(dāng)值或超出限制等現(xiàn)象。5-5:防止局部變量與公共變量同名。5-6:嚴(yán)禁將未初始化的變量用作右側(cè)值。6函數(shù),進(jìn)程6-1:調(diào)用函數(shù)的錯(cuò)誤返回代碼必須慎重、全面地處理。是否免費(fèi)6-2:準(zhǔn)確(非近似值)實(shí)現(xiàn)函數(shù)設(shè)計(jì)的明確函數(shù)功能。是否免費(fèi)6-3:編寫再入函數(shù)時(shí),必須注意局部變量的使用(例如,為C/C語言
9、編寫再入函數(shù)時(shí),必須使用auto默認(rèn)局部變量或寄存器變量)。是否免費(fèi)6-4:如果在編寫再入函數(shù)時(shí)使用全局變量,則應(yīng)使用中斷、信號量(即p,v操作)等手段保護(hù)它。是否免費(fèi)7可測試性7-1:在同一項(xiàng)目組或產(chǎn)品組中,必須有一組為集成測試和系統(tǒng)連接準(zhǔn)備的集成測試開關(guān)及其打印函數(shù),并具有詳細(xì)說明。是否免費(fèi)7-2:在同一項(xiàng)目組或產(chǎn)品組中測試和打印的信息格式必須統(tǒng)一。信息字符串必須至少包含模塊名(或源文件名)和行號。是否免費(fèi)7-3:在編程時(shí),為單元測試選擇合適的測試點(diǎn),仔細(xì)編寫測試代碼、測試用例,并給出明確的說明。測試代碼部分應(yīng)作為(模塊上的)子模塊(通過調(diào)節(jié)開關(guān)),以便于測試模塊中的代碼安裝和卸載。是否免
10、費(fèi)7-4:在繼續(xù)進(jìn)行集成測試/系統(tǒng)調(diào)整之前,構(gòu)建測試環(huán)境、測試項(xiàng)目和測試案例,并仔細(xì)分析和優(yōu)化測試案例以提高測試效率。是否免費(fèi)7-5:使用斷言發(fā)現(xiàn)軟件問題,提高代碼測試的可能性。是否免費(fèi)7-6:使用斷言檢查程序不能正常運(yùn)行,但在調(diào)節(jié)時(shí)可能出現(xiàn)的非法情況。是否免費(fèi)7-7:最終產(chǎn)品確實(shí)發(fā)生,必須處理的錯(cuò)誤情況不能通過斷言確認(rèn)。是否免費(fèi)7-8:為更復(fù)雜的斷言添加明確的解釋。是否免費(fèi)7-9:使用斷言檢查函數(shù)的參數(shù)。是否免費(fèi)7-10:斷言未定義的特性或功能未使用。是否免費(fèi)7-11:使用斷言檢查程序開發(fā)環(huán)境(OS/Compiler/Hardware)中的假設(shè)。是否免費(fèi)7-12:斷言和其他調(diào)節(jié)代碼必須從正式
11、軟件產(chǎn)品中刪除(即關(guān)閉相關(guān)調(diào)節(jié)開關(guān))。是否免費(fèi)7-13:在軟件系統(tǒng)中設(shè)置和取消測試工具不會(huì)影響軟件實(shí)現(xiàn)的功能等。是否免費(fèi)7-14:為了減少維護(hù)困難,使用測試開關(guān)切換軟件的調(diào)試版本和正式版本,而不是同時(shí)擁有正式版本和調(diào)試版本的源文件。是否免費(fèi)7-15:DEBUG版本和軟件發(fā)行版必須成批維護(hù),不允許分家,應(yīng)始終注意兩個(gè)版本在功能上保持一致。是否免費(fèi)8計(jì)劃效率8-1:編程時(shí)應(yīng)始終注意代碼的效率。是否免費(fèi)8-2:通過確保軟件系統(tǒng)的準(zhǔn)確性、可靠性、可讀性和可測試性,提高代碼效率。是否免費(fèi)8-3:本地效率必須是全球效率,本地效率的提高不能影響全球效率。是否免費(fèi)8-4:改進(jìn)系統(tǒng)數(shù)據(jù)結(jié)構(gòu)的分割和組織,優(yōu)化程序
12、算法,提高空間效率。是否免費(fèi)8-5:最小化循環(huán)中的工作量。是否免費(fèi)9質(zhì)量保證9-1:在軟件設(shè)計(jì)過程中構(gòu)建軟件質(zhì)量。是否免費(fèi)9-2:代碼質(zhì)量保證優(yōu)先原則是否免費(fèi)9-3:僅指屬于您的存儲(chǔ)空間。是否免費(fèi)9-4:防止引用已釋放的內(nèi)存空間。是否免費(fèi)9-5:從程序/函數(shù)配置的記憶體,直到程序/函數(shù)終止為止。是否免費(fèi)9-6:流程/函數(shù)申請的(用于打開文件的)文件句柄將關(guān)閉,直到流程/函數(shù)終止。是否免費(fèi)9-7:確保內(nèi)存活動(dòng)不超過限制。是否免費(fèi)9-8:仔細(xì)處理程序可能出現(xiàn)的各種錯(cuò)誤情況。是否免費(fèi)9-9:初始化變量和執(zhí)行環(huán)境,以便系統(tǒng)啟動(dòng)時(shí)不引用未初始化的變量。是否免費(fèi)9-10:在系統(tǒng)運(yùn)行的早期對加載到系統(tǒng)中的數(shù)據(jù)執(zhí)行一致性檢查。是否免費(fèi)9-11:嚴(yán)禁隨意更改其他模塊或系統(tǒng)的設(shè)置和配置。是否免費(fèi)9-12:
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲(chǔ)空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
- 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- GB/T 47040-2026航空航天鈦及鈦合金硫酸陽極氧化處理工藝
- JJG 543-2026心電圖機(jī)檢定規(guī)程
- GB 7300.309-2025飼料添加劑第3部分:礦物元素及其絡(luò)(螯)合物乳酸亞鐵
- 圓珠筆制造工崗前實(shí)操操作考核試卷含答案
- 海城培訓(xùn)班教學(xué)課件
- 漁船無線電操作員復(fù)試強(qiáng)化考核試卷含答案
- 漁網(wǎng)具工變革管理測試考核試卷含答案
- 海參內(nèi)部培訓(xùn)課件
- 送受話器裝調(diào)工安全應(yīng)急競賽考核試卷含答案
- 橋梁運(yùn)架培訓(xùn)
- 婦科醫(yī)師年終總結(jié)和新年計(jì)劃
- 2026海南安??毓捎邢挢?zé)任公司招聘11人筆試模擬試題及答案解析
- 裝飾裝修工程施工組織設(shè)計(jì)方案(二)
- 2026上海碧海金沙投資發(fā)展有限公司社會(huì)招聘參考題庫必考題
- 靜脈用藥調(diào)配中心(PIVAS)年度工作述職報(bào)告
- 保險(xiǎn)業(yè)客戶服務(wù)手冊(標(biāo)準(zhǔn)版)
- 檢驗(yàn)科內(nèi)控制度
- DB44-T 2771-2025 全域土地綜合整治技術(shù)導(dǎo)則
- nccn臨床實(shí)踐指南:宮頸癌(2025.v2)課件
- 淺談醫(yī)藥價(jià)格管理現(xiàn)狀透析
- 全屋定制合同協(xié)議模板2025年標(biāo)準(zhǔn)版
評論
0/150
提交評論