代碼走查檢查表

1、代碼走查檢查表評(píng)審日期：年月曰評(píng)審對(duì)象作者評(píng)審人評(píng)審工作量廳 P檢查項(xiàng)評(píng)審意見(jiàn)走查前準(zhǔn)備1得到一份解釋代碼的最新的設(shè)計(jì)文檔， 作為代碼走查的經(jīng)委2代碼都已提交，版本今程序結(jié)構(gòu)組織1所有代碼的結(jié)構(gòu)清晰，具有良好的結(jié)構(gòu)外觀和整齊2所有的模塊（函數(shù)和外部接口）定義清晰，模塊分解清楚3所有的功能需求都明顯的覆蓋4整個(gè)代碼體系結(jié)構(gòu)組合合理，分層清晰，代碼之間功能劃分明確5所有的接口模塊化，盡量減少接口之間的耦合度，修改時(shí)盡量不影響其他代碼模塊6代碼體系構(gòu)架對(duì)空間和速度都已經(jīng)進(jìn)行考慮7數(shù)據(jù)庫(kù)操作、IO 操作等是否正確關(guān)閉資源。并且必須在try-catch-finally 的 finally 中關(guān)閉。8一個(gè)

2、業(yè)務(wù)如果進(jìn)行多次數(shù)據(jù)庫(kù)更新、添加、刪除是否止確添加事務(wù)。9進(jìn)行邏輯與、邏輯或判斷時(shí)是否使用短路與、短路或。10多處使用相同代碼時(shí)，應(yīng)定義唯一方法或變量以供使用。11對(duì)象是否使用工 J 獲取。12導(dǎo)入類(lèi)時(shí)，如果僅使用包中的幾個(gè)類(lèi)，應(yīng)導(dǎo)入具體類(lèi)，而/、是導(dǎo)入整個(gè)包。13數(shù)組聲明的時(shí)候使用 intindex,而不要使用intindex 口。14代碼實(shí)現(xiàn)的邏輯是否與詳細(xì)設(shè)計(jì)描述的邏輯一致15檢查類(lèi)中是否有無(wú)效的代碼或者是無(wú)用的代碼。16/、要使用 System.out.print（）以及 System.err 輸出，需要進(jìn)行日志處理17所有的文件名符合文件命名規(guī)范，見(jiàn)名知意18文件和模塊分組清晰19較

3、長(zhǎng)的語(yǔ)句、表達(dá)式或參數(shù)（80 字符）要分成多行書(shū)寫(xiě)，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語(yǔ)句可讀20每個(gè)程序文件都小于 2000 行代碼組織1數(shù)據(jù)庫(kù)查詢語(yǔ)句/、要出現(xiàn) select*2對(duì)需要處理的字符串定義為 StringBuffer,常量定義成靜態(tài)的。3所有的變量名都小于 32 字符4有返回值的方法是否止確返回。 Return 語(yǔ)句應(yīng)止義在方法結(jié)尾處。5代碼排版是否規(guī)范。61所有的行每行最多只有一句代碼或一個(gè)表達(dá)式7復(fù)雜的表達(dá)式具備可讀性，添加注釋說(shuō)明，表達(dá)式結(jié)構(gòu)清晰81續(xù)行縮進(jìn)9括號(hào)在合適的位置10每個(gè)順序的小塊用空行隔開(kāi)11

4、注釋和代碼對(duì)齊或接續(xù)在代碼之后12；JSP 必須不能有 basepath。13JSP 弓 1 用 js 全部要有 path14JSP 用的標(biāo)簽庫(kù)是否都正確引用。15JSP 寫(xiě)的 js 方法必須要有注釋。代碼是含可讀。16代碼的邏輯是否有問(wèn)題。17JSP 貝聞盡量/、要寫(xiě)過(guò)多的隱藏域。18JSP 頁(yè)面要注意排版、必要的注釋、盡量減少使用alert(),JS和 CSSB 非必要就放到外部白單獨(dú)義件中，在 JSP 中引用。19實(shí)例變量是否使用private修飾并止義getter、 setter方法。201連接數(shù)據(jù)庫(kù)的方法必須調(diào)用公用的方法。21異常要統(tǒng)一處理，異常處理方法是否符合項(xiàng)目組的約定22在

5、Action 中/、要過(guò)多的邏輯處理代碼231不要出現(xiàn)魔鬼數(shù)字24檢查可能出現(xiàn)空指針異常的地方,例如一個(gè)對(duì)象可能為空，卻調(diào)用它的方法或?qū)傩浴?51顯示的文本無(wú)拼寫(xiě)和語(yǔ)法錯(cuò)誤26所有的表達(dá)式使用了正確的操作符函數(shù)組織1所有的函數(shù)名都小于 64 個(gè)字符2函數(shù)高內(nèi)聚盡量只做一件事情，并做好3函數(shù)和其他代碼松耦合4所有的參數(shù)都被使用5如果一個(gè)函數(shù)有返回值，在所有的出口都有返回值6函數(shù)使用了最少數(shù)目的 return 語(yǔ)句7函數(shù)的參數(shù)個(gè)數(shù)小于 7 個(gè)81使用的算法說(shuō)明清楚9函數(shù)檢查了輸入數(shù)據(jù)的合法性10函數(shù)異常處理清楚11函數(shù)設(shè)計(jì)盡量考慮將來(lái)的變化121調(diào)試信息存在于代碼中并容易激活13遞歸定義了出口14

6、遞歸局限于一個(gè)函數(shù)15對(duì)接口的調(diào)用必須要有判斷傳入的參數(shù)不能為空和傳入的參數(shù)止確。數(shù)據(jù)類(lèi)型與變量1數(shù)據(jù)類(lèi)型存在數(shù)據(jù)類(lèi)型解釋2代碼避免了重新定義預(yù)先定義的數(shù)據(jù)類(lèi)型3每一個(gè)變量都初始化了4所有的變量都有最小的活動(dòng)范圍51所有的全局變量都描述清楚，如全局變量的作用6所有的變量都用到了條件判斷1If/else 使用止確2判斷的次數(shù)降到最小3Boolean 表達(dá)式表小清楚4最常用的情況最先判斷，所有的情況都考慮5判斷體足夠短，以使得一次可以看清楚，不要后臃月中的邏輯判斷。6嵌套層次小于 3 次7判斷條件使用引用時(shí)，應(yīng)先判斷其是否為 null。循環(huán)1不要出現(xiàn)二層以上的 for 循環(huán)。 如有必要必須寫(xiě)?青楚

7、注釋21循環(huán)體不為空，循環(huán)體能夠一次看清楚3循環(huán)之前做好初始化代碼4當(dāng)有明確的多次循環(huán)操作，使用 For 循環(huán)5當(dāng)有不明確的多次循環(huán)操作，while 循環(huán)被使用6代碼中/、存在無(wú)窮次循環(huán)7循環(huán)的頭部進(jìn)行循環(huán)控制8循環(huán)體內(nèi)的循環(huán)變量起到指示作用。9所有的循環(huán)邊界是否正確；10循環(huán)終止的條件清晰11循環(huán)條件、判斷條件的邊界值，數(shù)組、集合下標(biāo)是否越界。注釋1類(lèi)、方法、判斷條件、循環(huán)、主要變量是否添加注釋。2類(lèi)名、方法名、變量名的命名是否規(guī)范。3有返回值的方法是否止確返回。 Return 語(yǔ)句應(yīng)止義在方法結(jié)尾處。4源代碼能夠自我解釋?zhuān)總€(gè)人看到代碼就能很快理解5解釋不過(guò)于簡(jiǎn)單，解釋說(shuō)明代碼功能，準(zhǔn)確描

8、述代碼意義6所有的假設(shè)和限制進(jìn)行注解7長(zhǎng)的控制體結(jié)束，進(jìn)行注解8對(duì) if 和 for、while 等要進(jìn)仃必要的注釋?zhuān)⑶曳椒w都要用包起來(lái)91代碼的注釋不能過(guò)于簡(jiǎn)單，要清晰明了。10缺陷修改階段， 提交代碼的時(shí)候必須寫(xiě)下青楚修改的功能點(diǎn)和為什么要修改?？偫?無(wú)用的代碼、注解已經(jīng)刪除2除非必要，/、要在循環(huán)體內(nèi)定義對(duì)象。其他注意項(xiàng)1盡量減少同名的類(lèi)(如 java.sql.Date,java.util.Date)2/、要在循環(huán)中反復(fù)定義創(chuàng)建變量for()Stringstr=(newString)v.next();3可能重復(fù)執(zhí)行的 SQl 語(yǔ)句盡量使用 preparedStatment4浮點(diǎn)型要精確比較時(shí)/、要使用=,而如下進(jìn)行Math.abs(x-0.0)Double.MIN.value*25在 sql 中注意敏感的單詞要回避使用DB2 中 idflagyearmonthnamestateOracle 中 numberSybase 中 count6代碼與操作系統(tǒng)無(wú)關(guān)，不需