JAVA代碼審查檢查表.doc

JAVA軟件代碼審查表(CHECKLIST)序號(hào)總 則 條 款執(zhí)行情況說明1 命名規(guī)則11.1 命名規(guī)則是否與所采用的規(guī)范保持一致是 否 免 21.2 是否遵循了最小長度最多信息原則是 否 免 31.3 has/can/is前綴的函數(shù)是否返回布爾型是 否 免 2 注 釋42.1注釋是否較清晰且必要是 否 免 52.2復(fù)雜的分支流程是否已經(jīng)被注釋是 否 免 62.3距離較遠(yuǎn)的是否已經(jīng)被注釋是 否 免 72.4非通用變量是否全部被注釋是 否 免 82.5函數(shù)是否已經(jīng)有文檔注釋是 否 免 92.6特殊用法是否被注釋是 否 免 3 聲明 空白 縮進(jìn)103.1每行是否只聲明了一個(gè)變量（特別是那些可能出錯(cuò)的類型）是 否 免 113.2變量是否已經(jīng)在定義的同時(shí)初始化是 否 免 123.3類屬性是否都執(zhí)行了初始化是 否 免 133.4代碼段落是否被合適地以空行分隔是 否 免 143.5是否合理地使用了空格使程序更清晰是 否 免 153.6代碼行長度是否在要求之內(nèi)是 否 免 163.7折行是否恰當(dāng)是 否 免 4 語句/功能劃分/規(guī)模174.1包含復(fù)合語句的是否成對(duì)出現(xiàn)并符合規(guī)范是 否 免 184.2是否給單個(gè)的循環(huán)、條件語句也加了是 否 免 194.3 if/if-else/if-else if-else/do-while/switch-case語句的格式是否符合規(guī)范是 否 免 204.4單個(gè)變量是否只做單個(gè)用途是 否 免 214.5單行是否只有單個(gè)功能（不要使用；進(jìn)行多行合并）是 否 免 224.6單個(gè)函數(shù)是否執(zhí)行了單個(gè)功能并與其命名相符是 否 免 234.7操作符+和-操作符的應(yīng)用是否復(fù)合規(guī)范是 否 免 244.8單個(gè)函數(shù)不超過規(guī)定行數(shù)是 否 免 254.9縮進(jìn)層數(shù)是否不超過規(guī)定是 否 免 5 可靠性（總則/變量和語句）265.1是否已經(jīng)消除了所有警告是 否 免 275.2常數(shù)變量是否聲明為final是 否 免 285.3對(duì)象使用前是否進(jìn)行了檢查是 否 免 295.4局部對(duì)象變量使用后是否被復(fù)位為NULL是 否 免 305.5對(duì)數(shù)組的訪問是否是安全的（合法的index取值為0, MAX_SIZE-1）是 否 免 315.6是否確認(rèn)沒有同名變量局部重復(fù)定義問題是 否 免 325.7程序中是否只使用了簡單的表達(dá)式是 否 免 335.8是否已經(jīng)用（）使操作符優(yōu)先級(jí)明確化是 否 免 345.9所有判斷是否都使用了（常量=變量）的形式是 否 免 355.10是否消除了流程懸掛是 否 免 365.11是否每個(gè)if-else if-else語句都有最后一個(gè)else以確保處理了全集是 否 免 375.12是否每個(gè)switch-case語句都有最后一個(gè)default以確保處理了全集是 否 免 385.13 for循環(huán)是否都使用了包含下限不包含上限的形式（k=0; kMAX）是 否 免 395.14 XML標(biāo)記書寫是否完整，字符串的拼寫是否正確是 否 免 405.15對(duì)于流操作代碼的異常捕獲是否有finally操作以關(guān)閉流對(duì)象是 否 免 415.16退出代碼段時(shí)是否對(duì)臨時(shí)對(duì)象做了釋放處理是 否 免 425.17對(duì)浮點(diǎn)數(shù)值的相等判斷是否是恰當(dāng)?shù)模▏?yán)禁使用=直接判斷）是 否 免 6 可靠性（函數(shù)）436.1入口對(duì)象是否都被進(jìn)行了判斷不為空是 否 免 446.2入口數(shù)據(jù)的合法范圍是否都被進(jìn)行了判斷(尤其是數(shù)組)是 否 免 456.3是否對(duì)有異常拋出的方法都執(zhí)行了try.catch保護(hù)是 否 免 466.4是否函數(shù)的所有分支都有返回值是 否 免 476.5 int的返回值是否合理（負(fù)值為失敗，非負(fù)值成功）是 否 免 486.6對(duì)于反復(fù)進(jìn)行了int返回值判斷是否定義了函數(shù)來處理是 否 免 496.7關(guān)鍵代碼是否做了捕獲異常處理是 否 免 506.8是否確保函數(shù)返回CORBA對(duì)象的任何一個(gè)屬性都不能為null是 否 免 516.9是否對(duì)方法返回值對(duì)象做了null檢查，該返回值定義時(shí)是否被初始化是 否 免 526.10是否對(duì)同步對(duì)象的遍歷訪問做了代碼同步是 否 免 536.11是否確認(rèn)在對(duì)Map對(duì)象使用迭代遍歷過程中沒有做增減元素操作是 否 免 546.12線程處理函數(shù)循環(huán)內(nèi)部是否有異常捕獲處理，防止線程拋出異常而退出是 否 免 556.13原子操作代碼異常中斷，使用的相關(guān)外部變量是否恢復(fù)先前狀態(tài)是 否 免 566.14函數(shù)對(duì)錯(cuò)誤的處理是恰當(dāng)?shù)氖?否 免 7 可維護(hù)性577.1實(shí)現(xiàn)代碼中是否消除了直接常量（用于計(jì)數(shù)起點(diǎn)的簡單常數(shù)例外）是 否 免 587.2是否消除了導(dǎo)致結(jié)構(gòu)模糊的連續(xù)賦值（如a= (b=d+c )）是 否 免 597.3是否每個(gè)return前都要