為什么需要編碼規(guī)范?

編碼規(guī)范對于程序員而言，尤為重要，有以下幾個原因：

一個軟件的生命周期中，80%的花費(fèi)在于維護(hù);

幾乎沒有任何一個軟件，在其整個生命周期中，均由最初的開發(fā)來維護(hù);

編碼規(guī)范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼;

如果你將源碼作為產(chǎn)品發(fā)布，就需要確認(rèn)它是否被很好的打包并且清晰無誤，一如你已構(gòu)建的其他任何產(chǎn)品;

命名

1.包命名

包名規(guī)則：一個唯一的包名的前綴總是全部小寫的ASCII字母并且是一個頂級域名，如com、edu、gov、net、org等。包名的后續(xù)部分根據(jù)不同機(jī)構(gòu)各自內(nèi)部的命名規(guī)范而不盡相同。這類命名規(guī)范需要以特定目錄名的組成來區(qū)分部門，項(xiàng)目，模塊等。

例如：com.bestpay.cif.core.manager --------重生項(xiàng)目的某一個包，在沒有特別要求的情況下，盡量按這種格式命名包名。

2.類和接口的命名

命名規(guī)則：每個單詞首字母大寫，盡量簡潔而富于描述。使用完整單詞，避免縮寫(除非縮寫已被廣泛使用)。

例如:

Activity ------ [xxx]Activity.java eg：SplashActivity

Dialog ------ [xxx]Dialog.java eg：LoginDialog

Service ------- [xxx]Service.java

常用的工具類--[xxx]Util.java

自動化測試的類命名一般在開發(fā)的類后面加Test即可，如開發(fā)的類名是Activity，測試的類名應(yīng)為ActivityTest。

3.方法的命名

命名規(guī)則：第一個單詞首字母小寫，其后單詞的首字母大寫，以包含測試場景為佳，如下兩個示例：

testOrderIsFilledIfEnoughInWarehouse()

testOrderDoesNotRemoveIfNotEnough()

注：樁方法應(yīng)該在方法后面中加上stub關(guān)鍵字。

4.變量命名

命名規(guī)則：第一個單詞首字母小寫，其后單詞首字母大寫。盡量避免單個字符的變量名。

5.常量命名

命名規(guī)則：類常量的聲明，應(yīng)該全部大寫，單詞間用下劃線隔開。

例如：

static final int MIN_WIDTH = 4 ;
static final int MAX_WIDTH = 999;

6.異常命名

命名規(guī)則：自定義異常的命名必須以Exception為結(jié)尾，用以明確表示為一個異常。

注釋

Java程序有兩類注釋：實(shí)現(xiàn)注釋(implementationcomments)和文檔注釋(document comments)。

實(shí)現(xiàn)注釋使用/*...*/ 和 // 。

文檔注釋使用/**...*/,文檔注釋可以通過javadoc工具轉(zhuǎn)換生成HTML文件

(1)文件注釋

所有源文件都應(yīng)該在開頭有一個注釋，其中列出類名、版本信息、日期和版權(quán)聲明。

/*
*?文件名
*?包含類名列表
*?版本信息，版本號
*?創(chuàng)建日期。
*?版權(quán)聲明
*/

(2)類注釋

每一個類都應(yīng)該包含如下格式的注釋，以說明當(dāng)前類的功能等

/**
* ?類名
* ?@author作者?<br/>
*??????實(shí)現(xiàn)的主要功能。
*??????創(chuàng)建日期
*??????修改者，修改日期，修改內(nèi)容。
*/

(3)方法注釋

每一個方法都應(yīng)該包含如下格式的注釋，包括當(dāng)前方法的用途，當(dāng)前方法參數(shù)的含義，當(dāng)前方法的返回值的內(nèi)容和拋出異常的列表。

/**
*
*??方法的一句話概述
*?<p>方法詳述（簡單方法可不必詳述）</p>
*?@params?說明參數(shù)含義
*??@return說明返回值含義
*??@throws?IOException?說明發(fā)生此異常的條件
*??@throws?NullPointerException?說明發(fā)生此異常的條件
*/

(4)類成員變量和常量注釋

成員變量和常量要使用javadoc形式的注釋說明當(dāng)前變量或常量的含義。

/**
* ?XXXX含義
*/

(5)其他注釋

方法內(nèi)部的注釋如果需要多行使用/*…*/形式，如果單行使用//…形式注釋。方法內(nèi)部不要使用java doc注釋。