Java編程規(guī)范(二)

在上一篇的java編程規(guī)范(一)中我們講述了在Java編碼中的一般原則,雖然這些原則并不涉及具體的代碼規(guī)范,但是這些原則卻是我們在Java開發(fā)過程中所應該遵循的規(guī)范與思想。今天我們將學習一些涉及具體代碼書寫的格式規(guī)范。

二、格式規(guī)范

(一)縮進嵌套的代碼

為了增強代碼的可讀性,我們常常把一些單獨的語句組織成語句塊,并對各塊統(tǒng)一縮進使之與周圍代碼分開。

1、如果我們使用開發(fā)環(huán)境,則我們可以使用開發(fā)環(huán)境提供的縮進樣式。但是如果我們是手寫代碼,應該使用兩個空格縮進。

class MyFuction {
··void function(int arg) {
····if (arg < 0) {
······for (int i = 0; i <= arg; i++) {
········//  ...
······}
····}
··}
}

2、塊語句起始端的大括號應該放在引入塊語句那一行的最后,結束端的大括號要獨占一行,并且與引入嵌套語句那一行的第一個字母對齊。我們?nèi)粘J褂玫拇a規(guī)范如下:
類定義:

public class MyClass {
  ...
}

內(nèi)部類定義:


public class OuterClass {
  ···
  class InnerClass {
    ...
  }
}

方法定義:

void method(int j) {
  ···
}

for循環(huán)語句:

for (int i = 0; i <= j; i++) {
  ···
}

if-else語句:

if (j < 0) {
  ···
}
else if ( j > 0) {
  ···
}
else {
  ···
}

try,catch,finally塊:

try {
  ···
}
catch {
  ···
}
finally {
  ···
}

switch語句:

switch (value) {
  case 0:
    ···
    break;
  default:
    ···
    break;
}

while語句:

while (a < b) {
  ···
}

do-while語句:

do {
  ···
} while (a < b);

為了提高一個團隊的工作效率,不要讓每個組員任意選擇各自代碼里的縮進量及樣式,應該制定統(tǒng)一的一套標準的縮進規(guī)則,并且確保團隊里的每個人都遵循這個標準。

(二)斷開長句

盡管在窗口化的現(xiàn)代編輯器中,可以利用橫向滾動條來閱讀很長的單行代碼。但是打印機對于超過它最大打印寬度的語句,就會把它們截斷、換行或者打印在不同的頁上。因此,要把每行代碼的長度限制在打印環(huán)境所支持的最大寬度之內(nèi),這個值一般是80或者132個字符。

1、不要把多個語句放在同一行里以免超過最大可接受寬度。應該一條語句放置在一行里。

//  這樣寫太長
double x = Math.random(); double y = Math.random();

//  應該一句占一行
double x = Math.random();
double y = Math.random();

2、如果一行代碼中包含了復雜的表達式,就應該把它拆分為幾個短小的子表達式,每個子表達式的運算結果存儲在一個臨時變量里,并且單獨放置在一行。

//  這樣的表達式太長
double length = Math.sqrt(Math.pow(Math.random(),2.0),Math.pow(Math.random(),2.0));

//  應該按下面這樣拆分
double x = Math.pow(Math.random(),2.0);
double y = Math.pow(Math.random(),2.0);
double length = Math.sqrt(x + y);

(三) 使用空白

空白就是頁面上沒有可見字符的區(qū)域。代碼里如果空白太少就會不易閱讀和理解,所以應該使用足夠多的空白把方法、注釋、代碼塊和表達式展示清楚。

1、以下情況使用單空白來分隔:
(1)、右括號")"或者緊隨其后的關鍵字;關鍵字和緊隨其后的左括號"("或者"{";右括號")"和緊隨其后的左括號"{";其實細心的讀者會發(fā)現(xiàn)在上述內(nèi)容的介紹中已經(jīng)應用了這些規(guī)范,在此就不贅述了。

if (j < 0) {
  ···
}
else if ( j > 0) {
  ···
}
else {
  ···
}

(2)、除了"."之外的運算符與其前后的表達式之間。

double length = Math.sqrt(x * x + y * y);
double x = length > 0.0 ? (x / length) : x;

2、以下情況應該使用空行來分隔:
(1) 每個邏輯上獨立的方法實現(xiàn)之間

void handleInfo(Message message) {

  DataInput content = message.getDataInput();
  int messageType = content.readInt();
  
  switch (messageType) {
    
    case warning:
      ...
      break;
      
    case error:
      ...
      break;
      
      default:
        ...
        break;
  }
}

(2) 定義類或者接口時,每個成員之間使用空行

public class Car {
  
  class InnerCar {
    ...
  }
  
   private Bar bar;
   
   Foo(Bar bar) {
     this.bar = bar;
   }
}

(3) 源文件中,每個類和接口的定義之間要使用空行

interface Paly {
  ...
}
  
public class Person implements Play{
  ...
}

(四)不要直接使用Tab控制符

不同的環(huán)境對Tab控制符的解釋也是不同的,代碼的格式在原來的編輯環(huán)境下可能正確無誤,但是如果放到另一個對Tab控制符有不同解釋的系統(tǒng)中,可能格式混亂、無法閱讀。

為了避免出現(xiàn)以上的情況,我們應該使用空格來縮進代碼。在一個團隊中,應該設置團隊通用的縮進標準,并且團隊里的所有人都嚴格遵守這個標準。

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,460評論 6 538
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,067評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,467評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,468評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,184評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,582評論 1 325
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,616評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,794評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,343評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 41,096評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,291評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,863評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,513評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,941評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,190評論 1 291
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,026評論 3 396
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,253評論 2 375

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