常見編碼規範

常見編碼規範

1.明確方法功能，精確（而不是近似）地實現方法設計。如果乙個功能將在多處實現，即使只有兩行**，也應該編寫方法實現。

說明：雖然為僅用一兩行就可完成的功能去編方法好象沒有必要，但用方法可使功能明確化，增加程式可讀性，亦可方便維護、測試。

2.應明確規定對介面方法引數的合法性檢查應由方法的呼叫者負責還是由介面方法本身負責，預設是由方法呼叫者負責。

說明：對於模組間介面方法的引數的合法性檢查這一問題，往往有兩個極端現象，即：要麼是呼叫者和被呼叫者對引數均不作合法性檢查，結果就遺漏了合法性檢查這一必要的處理過程，造成問題隱患；要麼就是呼叫者和被呼叫者均對引數進行合法性檢查，這種情況雖不會造成問題，但產生了冗餘**，降低了效率。

3.明確類的功能，精確（而不是近似）地實現類的設計。乙個類僅實現一組相近的功能。說明：劃分類的時候，應該盡量把邏輯處理、資料和顯示分離，實現類功能的單一性。

說明：資料類不能包含資料處理的邏輯。通訊類不能包含顯示處理的邏輯。

4.所有的資料類必須過載tostring() 方法，返回該類有意義的內容。說明：父類如果實現了比較合理的tostring() ，子類可以繼承不必再重寫。

示例：public toponode

}5.資料庫操作、io操作等需要使用結束close()的物件必須在try -catch-finally 的finally中close()。

6.異常捕獲後，如果不對該異常進行處理，則應該記錄日誌（針對後台）。

說明：若有特殊原因必須用注釋加以說明。

7.自己丟擲的異常必須要填寫詳細的描述資訊。

說明：便於問題定位。

示例：throw new ioexception("writing data error! data: " + data.tostring());

在程式中使用異常處理還是使用錯誤返回碼處理，根據是否有利於程式結構來確定，並且異常和錯誤碼不應該混合使用，推薦使用異常。說明：乙個系統或者模組應該統一規劃異常型別和返回碼的含義。但是不能用異常來做一般流程處理的方式，不要過多地使用異常，異常的處理效率比條件分支低，而且異常的跳轉流程難以**。

9.避免使用不易理解的數字，用有意義的標識來替代。涉及物理狀態或者含有物理意義的常量，不應直接使用數字，必須用有意義的靜態變數來代替。

示例：如下的程式可讀性差

if (state == 0)

應改為如下形式

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)

10.陣列宣告的時候使用 int index ，而不要使用 int index 。說明：

11.異常捕獲盡量不要直接 catch (exception ex) ，應該把異常細分處理。

12.不要使用難懂的技巧性很高的語句，除非很有必要時。說明：高技巧語句不等於高效率的程式，實際上程式的效率關鍵在於演算法。

原文出處：