Java 程式碼風格與慣例

Java

Java 程式碼風格與慣例。

Package(套件)

規則：名稱全部小寫。

com.blogspot.tonycube;

Classes(類別)

規則：應該使用名詞，第一個單字首字母大寫，之後的單字的首字母也是大寫，盡量簡單且可以自我描述，避免使用縮寫字(誰知道那是什麼意思)。

class Store{...}
class OrderAgent{...}

Interfaces(介面)

規則：同Classes名稱首字母大寫。

interface Instrument{...}
interface RasterDelegate{...}

Methods(方法，或稱函式)

規則：應該使用動詞，第一個單字首字母小寫，之後的單字的首字母大寫。

go();
goToAndPlay();

Variables(屬性，或稱變數)

規則：和方法相似，第一個單字首字母小寫，之後的單字的首字母大寫。用在for迴圈的迭代變數通常使用i,j,k,m依序接著用；字元變數則用c,d,e。

int i;
char c;
long screenWidth;

Constants(常數)

規則：名稱全部大寫，且單字的分隔使用底線(_)來連接。

static final MIN_WIDTH = 10;
static final MAX_WIDTH = 100;

幾個程式碼寫法的調整

if 條件

不建議的寫法：

if  (condition)
statement;

修改的寫法：清楚明瞭可以減少發生bug的機會

if (condition){
statement;
}

屬性宣告及初始值

不建議的寫法：

mouseX = mouseY = 0;

修改的寫法：多寫一行不會打多少字，卻可以讓閱讀變得輕鬆

mouseX = 0;
mouseY = 0;

善用括號

不建議的寫法：

if (a == b && c == d)

修改的寫法：不要挑戰自己對運算子優先順序的記憶

if ((a == b) && (c == d))

返回值

不建議的寫法：

if (booleanExpression) {
return true;
}else {
return false;
}

修改的寫法：何必多此一舉

return booleanExpression;

if 條件

不建議的寫法：

if (condition) {
return x;
}
return y;

修改的寫法：

return (condition ? x : y);

參考資料

• Code Conventions for the Java^TM Programming Language

本文網址：http://blog.tonycube.com/2009/02/java.html
由 Tony Blog 撰寫，請勿全文複製，轉載時請註明出處及連結，謝謝 😀