一耳幢、命名
命名要見名知意岸晦,最好都用英文欧啤。
1、類名用名詞
2启上、方法名用動詞
3邢隧、變量名寧可長一些說明清楚用途也不要用a、b冈在、c之類的無意義的名稱
4倒慧、循環(huán)計數(shù)器中用i、j包券、k等
二纫谅、注釋
1、方法名注釋2溅固、參數(shù)注釋3付秕、異常注釋4、返回值注釋5侍郭、定義參數(shù)變量询吴,非必要,如需說明可加但不要廢話
三励幼、參考規(guī)范
可以參考一些大企業(yè)的做法,例如Google口柳、Alibaba(規(guī)范見下面參考文獻(xiàn))等苹粟。
四、異常處理
描述清楚方便查找原因跃闹,同時寫一個異常處理類繼承RuntimeException嵌削,便于統(tǒng)一處理。
throw new ServiceException("參數(shù)分頁索引號pageIndex不能大于分頁總數(shù)");
五望艺、日志
用來記錄運(yùn)行時的錯誤信息苛秕,便于迅速排錯解決問題。
1找默、輸出有效信息
2艇劫、帶上下文信息
3、不輸出用戶的敏感信息惩激。
六店煞、參數(shù)校驗
場景:
1、方法或者函數(shù)是對外公開的风钻,不是私有的
2顷蟀、參數(shù)有可能為空指針的時候
3、參數(shù)的合理值無法通過方法名骡技、參數(shù)名鸣个、參數(shù)類型一眼看出來的時候!如下:
if (pageSize <0) {
thrownewIllegalArgumentException("pageSize不能小于0");? ?
?}
參考文獻(xiàn):
Bug輝博客 ?http://www.cnblogs.com/bughui/p/7422304.html
Google Java Style Guide https://google.github.io/styleguide/javaguide.html
阿里巴巴Java開發(fā)手冊 https://img.hacpai.com/file/2017/1/eb0998bac7664496b2f1af98e07b08e5-Java.pdf