上個(gè)月發(fā)布了Android項(xiàng)目重構(gòu)的三篇系列文章，其中，界面篇中提到了在項(xiàng)目中保持規(guī)范性的重要性，也有簡(jiǎn)單舉了幾個(gè)例子。這篇文章則將其延伸，提供更完整的開(kāi)發(fā)規(guī)范說(shuō)明。
書(shū)寫(xiě)規(guī)范
1.編碼方式統(tǒng)一用UTF-8. Android Studio默認(rèn)已是UTF-8，只要不去改動(dòng)它就可以了。
2.縮進(jìn)統(tǒng)一為4個(gè)空格，將Tab size設(shè)置為4則可以保證tab鍵按4個(gè)空格縮進(jìn)。另外，不要勾選上Use tab character，可以保證切換到不同tab長(zhǎng)度的環(huán)境時(shí)還能繼續(xù)保持統(tǒng)一的4個(gè)空格的縮進(jìn)樣式。
3.花括號(hào)不要單獨(dú)一行，和它前面的代碼同一行。而且，花括號(hào)與前面的代碼之間用一個(gè)空格隔開(kāi)。
public void method() { // Good
}
public void method()
{ // Bad
}
public void method(){ // Bad
}
4.空格的使用
// Good
if (booleanVariable) {
// TODO while booleanVariable is true
} else {
// TODO else
}
// Bad
if(booleanVariable) {
// TODO while booleanVariable is true
}else {
// TODO else
}
運(yùn)算符兩邊各用一個(gè)空格隔開(kāi)。
int result = a + b; //Good, = 和 + 兩邊各用一個(gè)空格隔開(kāi)
int result=a+b; //Bad,=和+兩邊沒(méi)用空格隔開(kāi)
方法的每個(gè)參數(shù)之間用一個(gè)空格隔開(kāi)。
public void method(String param1, String param2); // Good，param1后面的逗號(hào)與String之間隔了一個(gè)空格
method(param1, param2); // Good，方法調(diào)用時(shí)，param1后面的逗號(hào)與param2之間隔了一個(gè)空格
method(param1,param2); // Bad，沒(méi)有用一個(gè)空格隔開(kāi)
5.空行的使用
將邏輯相關(guān)的代碼段用空行隔開(kāi)，以提高可讀性。空行也只空一行，不要空多行。在以下情況需用一個(gè)空行：
- 兩個(gè)方法之間
- 方法內(nèi)的兩個(gè)邏輯段之間
- 方法內(nèi)的局部變量和方法的第一條邏輯語(yǔ)句之間
- 常量和變量之間
6.當(dāng)一個(gè)表達(dá)式無(wú)法容納在一行內(nèi)時(shí)，可換行顯示，另起的新行用8個(gè)空格縮進(jìn)。
someMethod(longExpression1, longExpression2, longExpression3,
longExpression4, longExpression5);
7.一行聲明一個(gè)變量，不要一行聲明多個(gè)變量，這樣有利于寫(xiě)注釋。
private String param1; // 參數(shù)1
private String param2; // 參數(shù)2
8.行寬設(shè)置為100，設(shè)置格式化時(shí)自動(dòng)斷行到行寬位置。
9.使用快捷鍵進(jìn)行代碼自動(dòng)格式化。
- Windows：
CTRL+ALT+L - Mac：
OPTION+COMMAND+L
10.一個(gè)方法最多不要超過(guò)40行代碼。
11.范圍型的常量用枚舉類(lèi)定義，而不要直接用整型或字符，這樣可以減少范圍值的有效性檢查。
// 用枚舉類(lèi)定義，Good
public enum CouponType {
// 現(xiàn)金券
@SerializedName("1")
CASH,
// 抵用券
@SerializedName("2")
DEBIT,
// 折扣券
@SerializedName("3")
DISCOUNT
}
// 用整型定義，Bad
public static final int TYPE_CASH = 1; // 現(xiàn)金券
public static final int TYPE_DEBIT = 2; // 抵扣券
public static final int TYPE_DISCOUNT = 3; // 折扣券
12.文字大小的單位統(tǒng)一用sp，元素大小的單位統(tǒng)一用dp。
13.應(yīng)用中的字符串統(tǒng)一在strings.xml中定義，然后在代碼和布局文件中引用。
14.顏色值統(tǒng)一在colors.xml中定義，然后在代碼和布局文件中引用。另外，不要在代碼和布局文件中引用系統(tǒng)的顏色，除了透明。
命名規(guī)范
1.包命名
域名反寫(xiě)+項(xiàng)目名稱(chēng)+模塊名稱(chēng)，全部單詞用小寫(xiě)字母。
例如，我的KAndroid項(xiàng)目的Model模塊包名如下：
me.keeganlee.kandroid.model
2.類(lèi)和接口命名
使用大駝峰規(guī)則，用名詞或名詞詞組命名，每個(gè)單詞的首字母大寫(xiě)。以下為幾種常用類(lèi)的命名：
-
activity類(lèi)，命名以Activity為后綴，如：LoginActivity -
fragment類(lèi)，命名以Fragment為后綴，如：ShareDialogFragment -
service類(lèi)，命名以Service為后綴，如：DownloadService -
adapter類(lèi)，命名以Adapter為后綴，如：CouponListAdapter - 工具類(lèi)，命名以
Util為后綴，如：EncryptUtil - 模型類(lèi)，命名以
BO為后綴，如：CouponBO - 接口實(shí)現(xiàn)類(lèi)，命名以
Impl為后綴，如：ApiImpl
3.方法命名
使用小駝峰規(guī)則，用動(dòng)詞命名，第一個(gè)單詞的首字母小寫(xiě)，其他單詞的首字母大寫(xiě)。以下為幾種常用方法的命名：
- 初始化方法，命名以
init開(kāi)頭，例：initView - 按鈕點(diǎn)擊方法，命名以
to開(kāi)頭，例：toLogin - 設(shè)置方法，命名以
set開(kāi)頭，例：setData - 具有返回值的獲取方法，命名以
get開(kāi)頭，例：getData - 通過(guò)異步加載數(shù)據(jù)的方法，命名以
load開(kāi)頭，例：loadData - 布爾型的判斷方法，命名以
is或has，或具有邏輯意義的單詞如equals，例：isEmpty
4.控件縮寫(xiě)
5.常量命名
全部為大寫(xiě)單詞，單詞之間用下劃線分開(kāi)。
public final static int PAGE_SIZE = 20;
6.變量命名
{范圍描述+}意義描述+類(lèi)型描述的組合，用駝峰式，首字母小寫(xiě)。
private TextView headerTitleTxt; // 標(biāo)題欄的標(biāo)題
private Button loginBtn; // 登錄按鈕
private CouponBO couponBO; // 券實(shí)例
7.控件id命名
控件縮寫(xiě)_{范圍_}意義，范圍可選，只在有明確定義的范圍內(nèi)才需要加上。
<!-- 這是標(biāo)題欄的標(biāo)題 -->
<TextView
android:id="@+id/txt_header_title"
... />
<!-- 這是登錄按鈕 -->
<Button
android:id="@+id/btn_login"
... />
8.layout命名
組件類(lèi)型_{范圍_}功能，范圍可選，只在有明確定義的范圍內(nèi)才需要加上。
以下為幾種常用的組件類(lèi)型命名：
-
activity_{范圍_}功能，為Activity的命名格式 -
fragment_{范圍_}功能，為Fragment的命名格式 -
dialog_{范圍_}功能，為Dialog的命名格式 -
item_list_{范圍_}功能，為ListView的item命名格式 -
item_grid_{范圍_}功能，為GridView的item命名格式 -
header_list_{范圍_}功能，為ListView的HeaderView命名格式 -
footer_list_{范圍_}功能，為ListView的FooterView命名格式
9.strings的命名
類(lèi)型_{范圍_}功能，范圍可選。以下為幾種常用的命名：
- 頁(yè)面標(biāo)題，命名格式為：
title_頁(yè)面 - 按鈕文字，命名格式為：
btn_按鈕事件 - 標(biāo)簽文字，命名格式為：
label_標(biāo)簽文字 - 選項(xiàng)卡文字，命名格式為：
tab_選項(xiàng)卡文字 - 消息框文字，命名格式為：
toast_消息 - 編輯框的提示文字，命名格式為：
hint_提示信息 - 圖片的描述文字，命名格式為：
desc_圖片文字 - 對(duì)話(huà)框的文字，命名格式為：
dialog_文字 - menu的item文字，命名格式為：
action_文字
10.colors的命名
前綴{_控件}{_范圍}{_后綴}，控件、范圍、后綴可選，但控件和范圍至少要有一個(gè)。
- 背景顏色，添加
bg前綴 - 文本顏色，添加
text前綴 - 分割線顏色，添加
div前綴 - 區(qū)分狀態(tài)時(shí)，默認(rèn)狀態(tài)的顏色，添加
normal后綴 - 區(qū)分狀態(tài)時(shí)，按下時(shí)的顏色，添加
pressed后綴 - 區(qū)分狀態(tài)時(shí)，選中時(shí)的顏色，添加
selected后綴 - 區(qū)分狀態(tài)時(shí)，不可用時(shí)的顏色，添加
disable后綴
11.drawable的命名
前綴{_控件}{_范圍}{_后綴}，控件、范圍、后綴可選，但控件和范圍至少要有一個(gè)。
- 圖標(biāo)類(lèi)，添加
ic前綴 - 背景類(lèi)，添加
bg前綴 - 分隔類(lèi)，添加
div前綴 - 默認(rèn)類(lèi)，添加
def前綴 - 區(qū)分狀態(tài)時(shí)，默認(rèn)狀態(tài)，添加
normal后綴 - 區(qū)分狀態(tài)時(shí)，按下時(shí)的狀態(tài)，添加
pressed后綴 - 區(qū)分狀態(tài)時(shí)，選中時(shí)的狀態(tài)，添加
selected后綴 - 區(qū)分狀態(tài)時(shí)，不可用時(shí)的狀態(tài)，添加
disable后綴 - 多種狀態(tài)的，添加
selector后綴（一般為L(zhǎng)istView的selector或按鈕的selector）
12.動(dòng)畫(huà)文件命名
動(dòng)畫(huà)類(lèi)型_動(dòng)畫(huà)方向。
-
fade_in，淡入 -
fade_out，淡出 -
push_down_in，從下方推入 -
push_down_out，從下方推出 -
slide_in_from_top，從頭部滑動(dòng)進(jìn)入 -
zoom_enter，變形進(jìn)入 -
shrink_to_middle，中間縮小
注釋規(guī)范
1.文件頭注釋
文件頂部統(tǒng)一添加版權(quán)聲明，聲明的格式如下：
/**
* Copyright (c) 2015. Keegan小鋼 Inc. All rights reserved.
*/
2.類(lèi)和接口注釋
類(lèi)和接口統(tǒng)一添加javadoc注釋?zhuān)袷饺缦拢?/p>
/**
* 類(lèi)或接口的描述信息
*
* @author ${USER}
* @date ${DATE}
*/
3.方法注釋
下面幾種方法，都必須添加javadoc注釋?zhuān)f(shuō)明該方法的用途和參數(shù)說(shuō)明，以及返回值的說(shuō)明。
- 接口中定義的所有方法
- 抽象類(lèi)中自定義的抽象方法
- 抽象父類(lèi)的自定義公用方法
- 工具類(lèi)的公用方法
**
* 登錄
*
* @param loginName 登錄名
* @param password 密碼
* @param listener 回調(diào)監(jiān)聽(tīng)器
*/
public void login(String loginName, String password, ActionCallbackListener<Void> listener);
4.變量和常量注釋
下面幾種情況下的常量和變量，都要添加注釋說(shuō)明，優(yōu)先采用右側(cè)//來(lái)注釋?zhuān)糇⑨屨f(shuō)明太長(zhǎng)則在上方添加注釋。
- 接口中定義的所有常量
- 公有類(lèi)的公有常量
- 枚舉類(lèi)定義的所有枚舉常量
- 實(shí)體類(lèi)的所有屬性變量
public static final int TYPE_CASH = 1; // 現(xiàn)金券
public static final int TYPE_DEBIT = 2; // 抵扣券
public static final int TYPE_DISCOUNT = 3; // 折扣券
private int id; // 券id
private String name; // 券名稱(chēng)
private String introduce; // 券簡(jiǎn)介
結(jié)束語(yǔ)
這份開(kāi)發(fā)規(guī)范說(shuō)明比較細(xì)，也許還不是非常完整，但里面提到的每一條規(guī)范都很有用。按照此規(guī)范嚴(yán)格執(zhí)行，將大大提高代碼的可讀性和維護(hù)性。
