2021-04-20代碼規(guī)范

代碼規(guī)范

  1. 代碼因遵循國際java代碼規(guī)范
  2. 方法的作用必須注釋,方法中傳遞的參數(shù)應(yīng)該有注釋晌砾,全局變量坎拐、局部變量都應(yīng)該有注釋,以說明變量的意義
  3. 代碼中應(yīng)采用try catch 捕獲異常,且應(yīng)該處理常見異常
  4. 代碼不應(yīng)出現(xiàn)重復(fù)定義
  5. 同一方法代碼量不超過50行則應(yīng)進(jìn)行拆分
  6. 代碼應(yīng)遵循可讀性原則哼勇,不能出現(xiàn)過于冗長的代碼
  7. 已經(jīng)失效都伪,且不會被調(diào)用的代碼應(yīng)該注銷或刪除
  8. 代碼應(yīng)該采用format格式化
  9. 代碼在未經(jīng)測試時(shí),不要進(jìn)行提交积担,以免造成調(diào)用的其他類出現(xiàn)錯(cuò)誤
  10. 項(xiàng)目的配置文檔應(yīng)該遵循規(guī)范格式陨晶,盡量增加注釋
  11. 頁面中提交的必要的變量參數(shù)應(yīng)該有驗(yàn)證
  12. 頁面提交的信息或執(zhí)行時(shí)間過長時(shí),頁面上傳文檔時(shí)應(yīng)該提示用戶“正在執(zhí)行”等樣式
  13. 頁面提交應(yīng)該有返回提示帝璧,如執(zhí)行成功先誉、執(zhí)行失敗。返回提示應(yīng)具有可讀性的烁,不得出現(xiàn)英文粗歐文提示
  14. 代碼的業(yè)務(wù)規(guī)范應(yīng)遵從嚴(yán)謹(jǐn)?shù)脑瓌t褐耳,在進(jìn)行數(shù)據(jù)操作時(shí),出現(xiàn)異常應(yīng)有回滾操作
  15. 如集合中的數(shù)據(jù)在一個(gè)類中對被多次調(diào)用渴庆,應(yīng)該定義到類的全局變量中铃芦,在同一類的不同方法中進(jìn)行調(diào)用,避免重復(fù)占用內(nèi)存
  16. 控制臺應(yīng)可以進(jìn)行打印襟雷,線條采用雙線
  17. 代碼在提交時(shí)刃滓,不應(yīng)出現(xiàn)測試用的log內(nèi)容,前期試運(yùn)行時(shí)如需運(yùn)行時(shí)如需給你總則應(yīng)注明耸弄,在正常云翔后進(jìn)行刪除或注銷
  18. 避免在for循環(huán)中反復(fù)帶哦用數(shù)據(jù)庫進(jìn)行對比
  19. 方法名及類名稱應(yīng)具備一定意義咧虎,而非隨意命名
  20. 方法在不同的類中出現(xiàn)反復(fù)調(diào)用情況時(shí),應(yīng)該寫到tools包中计呈,一共調(diào)用砰诵,諸如時(shí)間格式化、以時(shí)間獲取編碼等
  21. 不得隨意覆蓋其他人提交的代碼震叮,提交時(shí)應(yīng)給予溝通胧砰,驗(yàn)證無問題、不影響系統(tǒng)運(yùn)行苇瓣、不影響系統(tǒng)參數(shù)傳遞及結(jié)果時(shí),才可提交偿乖。
  22. 所有代碼功能都要進(jìn)行詳細(xì)測試击罪,并注明測試?yán)y試結(jié)果贪薪、問題跟蹤及解決情況
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末媳禁,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子画切,更是在濱河造成了極大的恐慌竣稽,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,561評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異毫别,居然都是意外死亡娃弓,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,218評論 3 385
  • 文/潘曉璐 我一進(jìn)店門岛宦,熙熙樓的掌柜王于貴愁眉苦臉地迎上來台丛,“玉大人,你說我怎么就攤上這事砾肺⊥烀梗” “怎么了?”我有些...
    開封第一講書人閱讀 157,162評論 0 348
  • 文/不壞的土叔 我叫張陵变汪,是天一觀的道長侠坎。 經(jīng)常有香客問我,道長裙盾,這世上最難降的妖魔是什么实胸? 我笑而不...
    開封第一講書人閱讀 56,470評論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮闷煤,結(jié)果婚禮上童芹,老公的妹妹穿的比我還像新娘。我一直安慰自己鲤拿,他們只是感情好假褪,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,550評論 6 385
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著近顷,像睡著了一般生音。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上窒升,一...
    開封第一講書人閱讀 49,806評論 1 290
  • 那天缀遍,我揣著相機(jī)與錄音,去河邊找鬼饱须。 笑死域醇,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的蓉媳。 我是一名探鬼主播譬挚,決...
    沈念sama閱讀 38,951評論 3 407
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼酪呻!你這毒婦竟也來了减宣?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,712評論 0 266
  • 序言:老撾萬榮一對情侶失蹤玩荠,失蹤者是張志新(化名)和其女友劉穎漆腌,沒想到半個(gè)月后贼邓,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,166評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡闷尿,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,510評論 2 327
  • 正文 我和宋清朗相戀三年塑径,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片悠砚。...
    茶點(diǎn)故事閱讀 38,643評論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡晓勇,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出灌旧,到底是詐尸還是另有隱情绑咱,我是刑警寧澤,帶...
    沈念sama閱讀 34,306評論 4 330
  • 正文 年R本政府宣布枢泰,位于F島的核電站描融,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏衡蚂。R本人自食惡果不足惜窿克,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,930評論 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望毛甲。 院中可真熱鬧年叮,春花似錦、人聲如沸玻募。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,745評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽七咧。三九已至跃惫,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間艾栋,已是汗流浹背爆存。 一陣腳步聲響...
    開封第一講書人閱讀 31,983評論 1 266
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留蝗砾,地道東北人先较。 一個(gè)月前我還...
    沈念sama閱讀 46,351評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像悼粮,于是被迫代替她去往敵國和親拇泣。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,509評論 2 348

推薦閱讀更多精彩內(nèi)容