1. 程式人生 > 其它 >編碼規約(三)程式碼格式

編碼規約(三)程式碼格式

所有內容摘自阿里巴巴的《Java開發手冊-嵩山版》

  1. 【強制】如果是大括號內為空,則簡潔的寫成 {} 即可,大括號中間無需換行和空格;如果是 非空程式碼塊則:
    1)左大括號前不換行。
    2)左大括號後換行。
    3)右大括號前換行。
    4)右大括號後還有 else 等程式碼則不換行;表示終止的右大括號後必須換行。

  2. 【強制】左小括號和右邊相鄰字元之間不出現空格;右小括號和左邊相鄰字元之間也不出現空格;而左大括號前需要加空格。

  3. 【強制】if / for / while / switch / do 等保留字與括號之間都必須加空格。

  4. 【強制】任何二目、三目運算子的左右兩邊都需要加一個空格。
    說明:包括賦值運算子 =、邏輯運算子 &&、加減乘除符號等。

  5. 【強制】採用 4 個空格縮排,禁止使用 Tab 字元。
    說明:如果使用 Tab 縮排,必須設定 1 個 Tab 為 4 個空格。IDEA 設定 Tab 為 4 個空格時,請勿勾選 Use tab character;而在 Eclipse 中,必須勾選 insert spaces for tabs。

  6. 【強制】註釋的雙斜線與註釋內容之間有且僅有一個空格。

  7. 【強制】在進行型別強制轉換時,右括號與強制轉換值之間不需要任何空格隔開。
    正例:double first = 3.2d;
    int second = (int)first + 2;

  8. 【強制】單行字元數限制不超過 120 個,超出需要換行,換行時遵循以下規則:
    1)第二行相對第一行縮排 4 個空格,從第三行開始,不再繼續縮排。
    2)運算子與下文一起換行。
    3)方法呼叫的點符號與下文一起換行。
    4)方法呼叫中的多個引數需要換行時,在逗號後換行。
    5)在括號前不要換行。

  9. 【強制】方法引數在定義和傳入時,多個引數逗號後面必須加空格。

  10. 【強制】IDE 的 text file encoding 設定為 UTF-8;IDE 中檔案的換行符使用 Unix 格式,不要使用 Windows 格式。

  11. 【推薦】單個方法的總行數不超過 80 行。
    說明:除註釋之外的方法簽名、左右大括號、方法內程式碼、空行、回車及任何不可見字元的總行數不超過 80行。
    正例:程式碼邏輯分清紅花和綠葉,個性和共性,綠葉邏輯單獨出來成為額外方法,使主幹程式碼更加清晰;共性邏輯抽取為共性方法,便於複用和維護。

  12. 【推薦】沒有必要增加若干空格來使變數的賦值等號與上一行對應位置的等號對齊。

  13. 【推薦】

    不同邏輯、不同語義、不同業務的程式碼之間插入一個空行分隔開來以提升可讀性。
    說明:任何情形,沒有必要插入多個空行進行隔開。


END


作者:金木研King
轉載請註明原文連結:https://www.cnblogs.com/jinzlblog/p/15234929.html