項(xiàng)目架構(gòu)的創(chuàng)建和代碼規(guī)范

創(chuàng)建

項(xiàng)目包架構(gòu)

1:首先打開(kāi)Eclipse開(kāi)發(fā)環(huán)境,新建JavaSE.

2:創(chuàng)建根包 com.feige。

3:在根包下創(chuàng)建子包? bean,service, tools。

4:?jiǎn)?dòng)類放在根包下。


代碼規(guī)范:

為保證FeiGe快遞系統(tǒng)代碼的規(guī)范性、可讀性,特制定該代碼規(guī)范。

(1)代碼應(yīng)遵循國(guó)際 Java 代碼規(guī)范。

(2)方法的作用必須注釋,方法中傳遞的參數(shù)應(yīng)該有注釋,全局變量、局部變 有注釋,以說(shuō)明變量的意義。

(3)代碼中應(yīng)該采用try catch 捕獲異常,且應(yīng)該處理常見(jiàn)異常。

(4)代碼不應(yīng)出現(xiàn)重復(fù)定義。

(5)同一方法中代碼量超過(guò)50行則應(yīng)進(jìn)行拆分。

(6)代碼應(yīng)該采用format 格式化。

(7)代碼應(yīng)遵循可讀性原則,不能出現(xiàn)過(guò)于冗長(zhǎng)的代碼。

(8)已經(jīng)失效,且不會(huì)被調(diào)用的代碼應(yīng)該注銷、刪除。

(9)代碼在未經(jīng)測(cè)試時(shí),不要進(jìn)行提交,以免造成調(diào)用的其他類出現(xiàn)錯(cuò)誤。

(10)項(xiàng)目的配置文檔應(yīng)該遵循規(guī)范格式,盡量增加注釋。

(11)頁(yè)面中提交的必要的變量參數(shù)應(yīng)該有驗(yàn)證。

(12)頁(yè)面提交的信息或執(zhí)行時(shí)間較長(zhǎng)時(shí),頁(yè)面上傳文檔時(shí)應(yīng)該提示, 行”等字樣。

(13)頁(yè)面提交信息應(yīng)該有返回提示,例如執(zhí)行成功、執(zhí)行失敗。返回 H威性,不得出現(xiàn)英文錯(cuò)誤提示。

(14)如集合中的數(shù)據(jù)在同一類中會(huì)被多次調(diào)用,應(yīng)該定義到類的全局變量中,在同—類的不同方法中進(jìn)行調(diào)用,避免重復(fù)占用內(nèi)存。

(15)代碼的業(yè)務(wù)規(guī)范應(yīng)該遵從嚴(yán)謹(jǐn)?shù)脑瓌t,在進(jìn)行數(shù)據(jù)操作時(shí),出現(xiàn)異常應(yīng)有回滾 操作。

(16)控制臺(tái)應(yīng)可以進(jìn)行打印,線條應(yīng)采用雙線。

(17)代碼在提交時(shí),不應(yīng)出現(xiàn)需要測(cè)試用的log內(nèi)容,前期試運(yùn)行時(shí)如需跟蹤則應(yīng)注明,在正常運(yùn)行后進(jìn)行刪除或注銷。

(18)避免在for循環(huán)中反復(fù)調(diào)用數(shù)據(jù)庫(kù)進(jìn)行對(duì)比。

(19)方法名及類名稱應(yīng)具備一定的意義,而非隨意命名。

(20)方法在不同的類中出現(xiàn)反復(fù)調(diào)用情況時(shí),應(yīng)該寫到tools 包中,以供調(diào)用,諸如 時(shí)間格式化、以時(shí)間獲取編號(hào)等。

(21)不得隨意覆蓋其他人提交的代碼,提交時(shí)應(yīng)給予溝通,驗(yàn)證無(wú)問(wèn)題、不影響系 統(tǒng)運(yùn)行、不影響系統(tǒng)參數(shù)傳遞及結(jié)果時(shí),才可提交。

(22)所有代碼功能都要進(jìn)行詳細(xì)測(cè)試,并注明測(cè)試用例、測(cè)試結(jié)果、問(wèn)題跟蹤及解 決情況。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容