編程規(guī)范

命名

1.命名的準則是準確的表達意義仗处。對于不同作用域的命名,可以選擇不同的長度。一般來說统翩,作用域小的變量(比如臨時變量)仁锯,可以選擇短一些的命名方式耀找。
2.可以借助類的信息來簡化屬性、函數的命名业崖,利用函數信息來簡化函數參數的命名野芒。

class User{
  String name;  // not userName
  String address;  // not userAddress
}

3.命名要可讀、可搜索双炕,不要使用生僻單詞來命名狞悲。
4.接口有兩種命名方式:一種是接口帶前綴“I”;另一種是在實現(xiàn)類中帶后綴“Impl”妇斤。抽象類也有兩種方式效诅,一種是帶前綴“Abstract”,一種是不帶趟济。重點是項目中要統(tǒng)一乱投。

注釋

1.注釋要包含三個方面:做什么、為什么顷编、怎么做戚炫。對于復雜類和接口,還需要寫明如何用媳纬。
2.注釋并非越多越好双肤。類和函數一定要寫注釋施掏,函數內部注釋相對少一些,一般都靠好的命名茅糜、提煉函數七芭、解釋性變量、總結性注釋來提高代碼可讀性蔑赘。

類中成員排列順序

在Google Java規(guī)范中狸驳,依賴類按照字母序從小到大排列。類中先寫成員變量后寫函數缩赛。成員變量之間或函數之間耙箍,先寫靜態(tài)成員變量或函數,后寫普通變量或函數酥馍,按照作用域大小依次排列辩昆。

把代碼分割為單元塊

當代碼邏輯比較復雜時,建議將其提煉為類或者函數旨袒,但是如果提煉出的函數只有兩三行汁针,則不建議。

避免函數參數過多

函數包含3砚尽、4個參數是可接受的施无,大于5個時,會影響到代碼可讀性尉辑。解決方法有兩種:

  • 考慮函數是否職責單一帆精,是否需要將一個函數拆分為多個函數较屿;
  • 將函數參數封裝為對象隧魄;

不用函數參數控制邏輯

不要在函數中用boolean類型的標識參數來控制內部邏輯,這違背了單一職責原則和接口隔離原則隘蝎,建議將其拆分為兩個函數购啄。

public void buyCourse(long userId, long courseId, boolean isVip);
// 將其拆分成兩個函數
public void buyCourse(long userId, long courseId);
public void buyCourseForVip(long userId, long courseId);

移除過深嵌套層次

代碼嵌套過深往往因為if-else、switch-case嘱么、for循環(huán)過度嵌套導致狮含。建議嵌套不要超過兩層,難以理解曼振。解決方法:

  • 去掉(合并)多余if或else几迄;
  • 使用continue、break冰评、return映胁,提前退出嵌套;
  • 調整執(zhí)行順序以減少嵌套甲雅;
  • 將部分嵌套邏輯封裝成函數調用解孙;

學會使用解釋性變量

1.用常量取代魔法數字坑填。

public double CalculateCircularArea(double radius) {
  return (3.1415) * radius * radius;
}

// 常量替代魔法數字
public static final Double PI = 3.1415;
public double CalculateCircularArea(double radius) {
  return PI * radius * radius;
}

2.使用解釋性變量解釋復雜表達式。

if (date.after(SUMMER_START) && date.before(SUMMER_END)) {
  // ...
} else {
  // ...
}

// 引入解釋性變量后邏輯更加清晰
boolean isSummer = date.after(SUMMER_START)&&date.before(SUMMER_END);
if (isSummer) {
  // ...
} else {
  // ...
} 
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末弛姜,一起剝皮案震驚了整個濱河市脐瑰,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌廷臼,老刑警劉巖苍在,帶你破解...
    沈念sama閱讀 212,686評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異中剩,居然都是意外死亡忌穿,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,668評論 3 385
  • 文/潘曉璐 我一進店門结啼,熙熙樓的掌柜王于貴愁眉苦臉地迎上來掠剑,“玉大人,你說我怎么就攤上這事郊愧∑右耄” “怎么了?”我有些...
    開封第一講書人閱讀 158,160評論 0 348
  • 文/不壞的土叔 我叫張陵属铁,是天一觀的道長眠寿。 經常有香客問我,道長焦蘑,這世上最難降的妖魔是什么盯拱? 我笑而不...
    開封第一講書人閱讀 56,736評論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮例嘱,結果婚禮上狡逢,老公的妹妹穿的比我還像新娘。我一直安慰自己拼卵,他們只是感情好奢浑,可當我...
    茶點故事閱讀 65,847評論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著腋腮,像睡著了一般雀彼。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上即寡,一...
    開封第一講書人閱讀 50,043評論 1 291
  • 那天徊哑,我揣著相機與錄音,去河邊找鬼聪富。 笑死莺丑,一個胖子當著我的面吹牛,可吹牛的內容都是我干的善涨。 我是一名探鬼主播窒盐,決...
    沈念sama閱讀 39,129評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼草则,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了蟹漓?” 一聲冷哼從身側響起炕横,我...
    開封第一講書人閱讀 37,872評論 0 268
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎葡粒,沒想到半個月后份殿,有當地人在樹林里發(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 44,318評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡嗽交,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,645評論 2 327
  • 正文 我和宋清朗相戀三年卿嘲,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片夫壁。...
    茶點故事閱讀 38,777評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡拾枣,死狀恐怖,靈堂內的尸體忽然破棺而出盒让,到底是詐尸還是另有隱情梅肤,我是刑警寧澤,帶...
    沈念sama閱讀 34,470評論 4 333
  • 正文 年R本政府宣布邑茄,位于F島的核電站姨蝴,受9級特大地震影響,放射性物質發(fā)生泄漏肺缕。R本人自食惡果不足惜左医,卻給世界環(huán)境...
    茶點故事閱讀 40,126評論 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望同木。 院中可真熱鬧浮梢,春花似錦、人聲如沸泉手。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,861評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽斩萌。三九已至,卻和暖如春屏轰,著一層夾襖步出監(jiān)牢的瞬間颊郎,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,095評論 1 267
  • 我被黑心中介騙來泰國打工霎苗, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留姆吭,地道東北人。 一個月前我還...
    沈念sama閱讀 46,589評論 2 362
  • 正文 我出身青樓唁盏,卻偏偏與公主長得像内狸,于是被迫代替她去往敵國和親检眯。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,687評論 2 351

推薦閱讀更多精彩內容