Java-初級編碼規範

• 2019 年 10 月 6 日
• 筆記

良好的編碼規範和習慣會讓你的程式碼錦上添花，同時也會大大的增加團隊協作開發的效率，避免很多細節的問題，從而大大的提高你的程式碼的可閱讀性，同時也是一個優秀開發者的必備技能之一，所以接下來，我們就一起來了解並掌握一些常見的編碼規範吧。

一、命名規範：

類名的首字母必須大寫。 所有成員變數、方法命名時，必須遵守駱駝命名法。

【PS：駱駝式命名法就是當變數名或函式名是由一個或多個單詞連結在一起，而構成的唯一識別字時，第一個單詞以小寫字母開始；第二個單詞的首字母大寫或每一個單詞的首字母都採用大寫字母，例如：myFirstName、myLastName，這樣的變數名看上去就像駱駝峰一樣此起彼伏，故得名——駱駝命名法，也叫駝峰命名】

範例：

openAccount();save(); getFirstName();isAtEnd();

一般運算符兩邊都必須有空格+、-、*、/、%、=、<、>、!=、<=、>= 兩邊空格，如：

String name = 「zn」; 2 – 1; 2 + 1; 2 * 1; 2 / 1; 2 % 1; 2 > 1; 2 > 1; 2 != 1; 2 <= 1; 2 >= 1;

一元運算可以除外，比如：i++; i–; ++i; –i; 書寫{ }採用如下格式：

public interface Interface {

public void showMessage() {

} }

抽象類以Abstract開頭；

public class AbstractCollection

介面的實現使用Impl結尾；

public class IteratorImpl implements Iterator

靜態不可變的變數全部使用大寫，並且單詞之間用_進行分隔：如

public static final int MAX_VALUE = 5;

包名由小寫字母和少量數字組成，包名統一用代表模組貼切含義的英文單詞或縮寫；

例如老九學堂的項目是這樣命名的： 包名一級為com; 包名二級為xuetang9; 包名三級為班級編號，prot001; 包名四級為小組名，如crazy; 包名五級按功能模組劃分等，如oofood；

所以包名為：com.xuetang9.prot001.crazy.oofood

二、注釋要求

注釋是幫助程式讀者的一種手段在編碼的過程中必須隨時加註釋，不能過後補齊。通過注釋描述當時的思路，以及懸而未決的問題；提高程式的可讀性，規範性，維護性。提供使用說明、及配置資訊。

1.每行注釋不超過40個中文字；

2.每個類、介面的開頭必須多行的詳細的功能說明，使用中文注釋，包括作者、版本、創建時間等等； 3.每個方法前面都必須使用Javadoc的中文注釋，必須說明該方法的作用與目的； 4.每個成員變數必須有單行中文注釋，必須說明該成員變數的作用與目的。 類注釋

/*** 作者：窖頭 * 功能：現存量業務邏輯 * 日期：2017-06-01 */

方法注釋

方法頭注釋必須包括：方法執行了什麼功能，為什麼要這樣處理；方法處理過程中對對象的那些屬性可能進行更改；方法執行前後，對象的狀態。

1.比較、循環等控制結構必須加註釋； 2.在程式碼的功能並非一目了然的情況下，應當說明為什麼要這樣做； 3.局部變數必須加註釋； 4.複雜難寫的程式碼必須加註釋； 5.如果一系列程式碼的前後執行順序有要求，必須注釋說明 方法開頭需要的注釋內容：作者、功能、參數說明、返回值、例外、日期、修改日期，修改人，修改原因。舉例：

/*** 作者：窖頭 * 功能：查詢現存量 * 參數： voCond：查詢條件VO voAstCond：附加條件VO * 返回：ResultVO：查詢結果 * 例外：DatabaseException * 日期：2017-06-01 * 修改日期，修改人，修改原因，注釋標誌： * 2017-06-16,李四，提高效率，lisi_start/lisi_end * 2017-07-16,王五，提高效率，wangwu_start/wangwu_end */

變數注釋

要求注釋所有的變數（域）。如下所示：

/** 標題 */ private String title = null; /** 訂單VO */ private PurchaseBillVO purchaseBillVO = null; 如果該注釋不用來生成javadoc文件：也可以採用以下形式： //標題 private String title = null; //訂單VO private PurchaseBillVO purchaseBillVO = null; 更多乾貨筆記關注微信公眾號 : 老九學堂