peoplesoft項目開發(fā)過程規(guī)范(編輯修改稿)
2025-05-04 06:26 本頁面
【文章內(nèi)容簡介】 命名規(guī)則是否與所采用的規(guī)范保持一致？成員變量，方法參數(shù)等需要使用首字母小寫，其余單詞首字母大寫的命名方式，禁止使用下劃線(_)數(shù)字等方式命名不要出現(xiàn)局部變量，成員變量大寫字母開頭等問題 一般是否遵循了最小長度最多信息原則？各種命名盡可能短，表意準(zhǔn)確，除2代替‘to’，4代替‘for’外，不建議使用數(shù)字在命名中 重要has/can/is前綴的函數(shù)是否返回布爾型？成員變量，方法參數(shù)，局部變量等為布爾型時，如果出現(xiàn)has/can/is開頭，則將這些詞去掉 重要類名是否存在重名問題？自己實(shí)現(xiàn)的類盡量不要和別人的類重名，盡管不在同一個包下，特別是子類和父類重名的情況注釋 重要注釋是否較清晰且必要？方法JAVADOC注釋中需要說明各參數(shù)、返回值及異常說明，參數(shù)說明需按照參數(shù)名稱及用意對應(yīng)標(biāo)注 重要復(fù)雜的分支流程是否已經(jīng)被注釋？ 一般距離較遠(yuǎn)的}是否已經(jīng)被注釋？ 重要函數(shù)是否已經(jīng)有文檔注釋？（功能、輸入、返回及其他可選）文件，類（含接口，枚舉等），成員變量，方法前需要有JAVADOC的注釋 一般特殊用法是否被注釋？ 聲明、空白、縮進(jìn) 一般每行是否只聲明了一個變量？（特別是那些可能出錯的類型） 重要變量是否已經(jīng)在定義的同時初始化？ 重要類屬性是否都執(zhí)行了初始化？ 一般代碼段落是否被合適地以空行分隔？ 一般是否合理地使用了空格使程序更清晰？基本代碼格式中的空格符不可缺少，這些空格出現(xiàn)在?,:,+,,*,/,=,==,=,=,!=,及各種括號附近 提示代碼行長度是否在要求之內(nèi)？每行不得超過120個字符 重要controller，service,dao中不要聲明有狀態(tài)的變量。此變量不能被修改。如果要進(jìn)行修改，必須通過鎖進(jìn)行控制。 一般折行是否恰當(dāng)？ 一般集合是否被定義為泛型類型？定義集合時，建議定義其泛型類型，減少類型轉(zhuǎn)換和警告錯誤語句/功能分布/規(guī)模 一般包含復(fù)合語句的{}是否成對出現(xiàn)并符合規(guī)范？ 重要是否給單個的循環(huán)、條件語句也加了{(lán)}？if,else,elseif,while,for,case等代碼塊必須用{}包圍 一般單個變量是否只做單個用途？ 重要單行是否只有單個功能？（不要使用；進(jìn)行多行合并） 重要單個函數(shù)是否執(zhí)行了單個功能并與其命名相符？ 一般操作符＋＋和——操作符的應(yīng)用是否符合規(guī)范？ 規(guī)模 重要單個函數(shù)不超過規(guī)定行數(shù)？ 重要縮進(jìn)層數(shù)是否不超過規(guī)定？ 可靠性（總則/變量和語句） 重要是否已經(jīng)消除了所有警告？開發(fā)工具的警告 重要常數(shù)變量是否聲明為final？ 重要對象使用前是否進(jìn)行了檢查？ 重要成員變量，局部變量是否在使用前被賦值？對象初始化為null的對象被調(diào)用前必須被重新賦值，如果賦值語句在try塊中，調(diào)用操作必須在try塊中 一般局部對象變量使用后是否被復(fù)位為NULL？特別是數(shù)組集合Map 重要對數(shù)組的訪問是否是安全的？（合法的index取值為[0,MAX_SIZE1]）?！ ≈匾欠翊_認(rèn)沒有同名變量局部重復(fù)定義問題?嚴(yán)禁局部變量名稱和類或?qū)ο蟪蓡T變量同名 一般程序中是否只使用了簡單的表達(dá)式？ 重要是否已經(jīng)用（）使操作符優(yōu)先級明確化？ 重要所有判斷是否都使用了（常量==變量或者(變量)）的形式？常量放在比較符前可以有效降低比較符寫成賦值語句，減少空指針異?！≈匾欠衩總€ifelseifelse語句都有最后一個else以確保處理了全集？ 重要是否每個switchcase語句都有最后一個default以確保處理了全集？ 一般for循環(huán)是否都使用了包含下限不包含上限的形式？（k=0。kMAX） 重要XML標(biāo)記書寫是否完整，字符串的拼寫是否正確? 重要對于流操作代碼的異常捕獲是否有finally操作以關(guān)閉流對象?關(guān)閉前需要判斷流對象是否為空 提示退出代碼段時是否對臨時對象做了釋放處理? 重要對浮點(diǎn)數(shù)值的相等判斷是否是恰當(dāng)?shù)?？?yán)禁使用==直接判斷浮點(diǎn)數(shù)值提供通用方法 重要是否對象比較都使用了equals？對象（包括包裝類）比較必須使用equals，而不是使用==或!=操作 重要使用equals進(jìn)行比較時是否確保比較的兩個對象類型一致？equals方法比較的對象在對象類型確定的前提下，建議是同一類型的，例如Integer和使用equals是不提倡的 一般操作Map或Prope
公司管理相關(guān)推薦
鄂ICP備17016276號-1