明確方法功能,精確(而不是近似)地實現(xiàn)方法設(shè)計。一個函數(shù)僅完成一件功能,即使簡單功能也應該編寫方法實現(xiàn)。
說明:雖然為僅用一兩行就可完成的功能去編方法好象沒有必要,但用方法可使功能明確化,增加程序可讀性,亦可方便維護、測試。對方法參數(shù)的合法性檢查由方法本身負責,方法調(diào)用者不負責。
說明:對于模塊間接口方法的參數(shù)的合法性檢查這一問題,往往有兩個極端現(xiàn)象,即:要么是調(diào)用者和被調(diào)用者對參數(shù)均不作合法性檢查,結(jié)果就遺漏了合法性檢查這一必要的處理過程,造成問題隱患;要么就是調(diào)用者和被調(diào)用者均對參數(shù)進行合法性檢查,這種情況雖不會造成問題,但產(chǎn)生了冗余代碼,降低了效率。明確類的功能,精確(而非近似)地實現(xiàn)類的設(shè)計。一個類僅實現(xiàn)一組相近的功能。
說明:劃分類的時候,應該盡量把邏輯處理、數(shù)據(jù)和顯示分離,實現(xiàn)類功能的單一性。
示例:
數(shù)據(jù)類不能包含數(shù)據(jù)處理的邏輯。
通信類不能包含顯示處理的邏輯。數(shù)據(jù)庫操作、IO操作等需要使用結(jié)束close()的對象必須在try -catch-finally 的finally中close()。
示例:
try
{
// ... ...
}
catch(IOException ioe)
{
//... ...
}
finally
{
try
{
out.close();
}
catch (IOException ioe)
{
//... ...
}
}
- 異常捕獲后,應該紀錄日志或者ex.printStackTrace() 。
說明:若有特殊原因必須用注釋加以說明。
示例:
try
{
//.... ...
}
catch (IOException ioe)
{
ioe.printStackTrace ();
}
- 采用錯誤返回碼代替拋出異常。一個函數(shù)必須在其內(nèi)部對所有異常進行處理, 禁止主動拋出的異常(禁止使用throw new IOException()),采用錯誤返回碼代替拋出異常。
- 注意運算符的優(yōu)先級,并用括號明確表達式的操作順序,避免使用默認優(yōu)先級。
說明:防止閱讀程序時產(chǎn)生誤解,防止因默認的優(yōu)先級與設(shè)計思想不符而導致程序出錯。
示例:
下列語句中的表達式
word = (high << 8) | low (1)
if ((a | b) && (a & c)) (2)
if ((a | b) < (c & d)) (3)
如果書寫為
high << 8 | low
a | b && a & c
a | b < c & d
雖然不會出錯,但語句不易理解;造成了判斷條件出錯。
- 避免使用不易理解的數(shù)字,用有意義的標識來替代。涉及物理狀態(tài)或者含有物理意義的常量,不應直接使用數(shù)字,必須用有意義的靜態(tài)變量來代替。
示例:如下的程序可讀性差。
if (state == 0)
{
state = 1;
... // program code
}
應改為如下形式:
private final static int TRUNK_IDLE = 0;
private final static int TRUNK_BUSY = 1;
private final static int TRUNK_UNKNOWN = -1;
if (state == TRUNK_IDLE)
{
state = TRUNK_BUSY;
... // program code
}
- 數(shù)組聲明的時候使用int index[],而不要使用int[] index。但函數(shù)返回值為數(shù)值類型時應使用int[] getIndex(),而不要使用int getIndex()[]。
示例:
如下程序可讀性差:
public int getIndex()[]
{
....
}
如下程序可讀性好:
public int[] getIndex()
{
....
}
調(diào)試代碼的時候,禁止使用 System.out 和 System.err 進行打印,應該使用log4j統(tǒng)一打印。
說明:代碼發(fā)布的時候可以統(tǒng)一關(guān)閉調(diào)試代碼,定位問題的時候又可以打開開關(guān)。禁止在版本正式代碼中寫測試代碼。測試代碼應使用junit單獨編寫。
一個函數(shù)除注釋、空行外的代碼行數(shù)不得超過50行。如果一個函數(shù)的代碼行數(shù)超過50行,必須把它拆分為多個函數(shù),直到每個函數(shù)的代碼行數(shù)小于等于50行為止。
禁止使用難懂的技巧性很高的語句。禁止使用不常用的語法。
說明:高技巧語句不等于高效率的程序,實際上程序的效率關(guān)鍵在于算法。
建議
記錄異常不要保存exception.getMessage(),而要記錄exception.toString()。
示例:NullPointException拋出時常常描述為空,這樣往往看不出是出了什么錯。異常捕獲盡量不要直接 catch (Exception ex),應該把異常細分處理。
如果多段代碼重復做同一件事情,那么在方法的劃分上可能存在問題。
說明:若此段代碼各語句之間有實質(zhì)性關(guān)聯(lián)并且是完成同一件功能的,那么可考慮把此段代碼構(gòu)造成一個新的方法。源程序中關(guān)系較為緊密的代碼應盡可能相鄰。
說明:便于程序閱讀和查找。
示例:矩形的長與寬關(guān)系較密切,放在一起。
rect.length = 10;
rect.width = 5;