編程規(guī)約

For variable name, always use English with lowerCamelCase.

space in comment:

bad example:

Suggestion: 與其“半吊子”英文來注釋，不如用中文注釋把問題說清楚。專有名詞與關(guān)鍵字保持英文原文即可。

謹(jǐn)慎注釋掉代碼。在上方詳細(xì)說明，而不是簡單地注釋掉。如果無用，則刪除。 說明：代碼被注釋掉有兩種可能性：1）后續(xù)會(huì)恢復(fù)此段代碼邏輯。2）永久不用。前者如果沒有備注信息，難以知曉注釋動(dòng)機(jī)。后者建議直接刪掉（代碼倉庫保存了歷史代碼）。

Do not mix production code with test code. All testing codes must be put to folder src\test\java.

Constant:

---

For boolean variable in POJO, no “is” prefix is allowed.

Always use meaningful naming for self-descriptive purpose.

Bad example: no prefix for local variable.

---

Naming per layer

---

Bracket usage

if( XXX ){yyy; }if( XXX ){yyy; } else{}

---

space usage

bad example:

space between method and argument:

bad example:

---

new line usage

guideline:

bad example:

---

text file encoding

IDE text file encoding: UTF-8; IDE new line format: use Unix instead of Windows
IDE setting:

why we should set this property

---

basic type and wrapper object

---

No business logic is allowed in constructor. If initialization logic is needed, put it in init().

class method sequence

public method > protected > private > getter / setter

---

No business logic in setter/getter

---

Bracket is mandatory in if/else/for/while/do.

Bad example:

if (condition) statements;

Better to use if XXX return; instead of if XXX else YYY:

參考文檔

阿里巴巴Java開發(fā)手冊終極版v1.3.0

更多Jerry的原創(chuàng)文章，盡在：“汪子熙”:

創(chuàng)作挑戰(zhàn)賽新人創(chuàng)作獎(jiǎng)勵(lì)來咯，堅(jiān)持創(chuàng)作打卡瓜分現(xiàn)金大獎(jiǎng)

總結(jié)

以上是生活随笔為你收集整理的一份我们团队Java开发的开发规范，参考了阿里巴巴Java开发手册终极版v1.3.0的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。