代碼規(guī)范
- 代碼因遵循國際java代碼規(guī)范
- 方法的作用必須注釋,方法中傳遞的參數(shù)應(yīng)該有注釋晌砾,全局變量坎拐、局部變量都應(yīng)該有注釋,以說明變量的意義
- 代碼中應(yīng)采用try catch 捕獲異常,且應(yīng)該處理常見異常
- 代碼不應(yīng)出現(xiàn)重復(fù)定義
- 同一方法代碼量不超過50行則應(yīng)進(jìn)行拆分
- 代碼應(yīng)遵循可讀性原則哼勇,不能出現(xiàn)過于冗長的代碼
- 已經(jīng)失效都伪,且不會被調(diào)用的代碼應(yīng)該注銷或刪除
- 代碼應(yīng)該采用format格式化
- 代碼在未經(jīng)測試時(shí),不要進(jìn)行提交积担,以免造成調(diào)用的其他類出現(xiàn)錯(cuò)誤
- 項(xiàng)目的配置文檔應(yīng)該遵循規(guī)范格式陨晶,盡量增加注釋
- 頁面中提交的必要的變量參數(shù)應(yīng)該有驗(yàn)證
- 頁面提交的信息或執(zhí)行時(shí)間過長時(shí),頁面上傳文檔時(shí)應(yīng)該提示用戶“正在執(zhí)行”等樣式
- 頁面提交應(yīng)該有返回提示帝璧,如執(zhí)行成功先誉、執(zhí)行失敗。返回提示應(yīng)具有可讀性的烁,不得出現(xiàn)英文粗歐文提示
- 代碼的業(yè)務(wù)規(guī)范應(yīng)遵從嚴(yán)謹(jǐn)?shù)脑瓌t褐耳,在進(jìn)行數(shù)據(jù)操作時(shí),出現(xiàn)異常應(yīng)有回滾操作
- 如集合中的數(shù)據(jù)在一個(gè)類中對被多次調(diào)用渴庆,應(yīng)該定義到類的全局變量中铃芦,在同一類的不同方法中進(jìn)行調(diào)用,避免重復(fù)占用內(nèi)存
- 控制臺應(yīng)可以進(jìn)行打印襟雷,線條采用雙線
- 代碼在提交時(shí)刃滓,不應(yīng)出現(xiàn)測試用的log內(nèi)容,前期試運(yùn)行時(shí)如需運(yùn)行時(shí)如需給你總則應(yīng)注明耸弄,在正常云翔后進(jìn)行刪除或注銷
- 避免在for循環(huán)中反復(fù)帶哦用數(shù)據(jù)庫進(jìn)行對比
- 方法名及類名稱應(yīng)具備一定意義咧虎,而非隨意命名
- 方法在不同的類中出現(xiàn)反復(fù)調(diào)用情況時(shí),應(yīng)該寫到tools包中计呈,一共調(diào)用砰诵,諸如時(shí)間格式化、以時(shí)間獲取編碼等
- 不得隨意覆蓋其他人提交的代碼震叮,提交時(shí)應(yīng)給予溝通胧砰,驗(yàn)證無問題、不影響系統(tǒng)運(yùn)行苇瓣、不影響系統(tǒng)參數(shù)傳遞及結(jié)果時(shí),才可提交偿乖。
- 所有代碼功能都要進(jìn)行詳細(xì)測試击罪,并注明測試?yán)y試結(jié)果贪薪、問題跟蹤及解決情況