10. 其他資源命名

遵循見名知意的原則，組成名稱的單詞必須全部小寫，單詞之間用下劃線隔開。

歡迎

#FFFFFF

注釋

養(yǎng)成良好的注釋習(xí)慣，對(duì)提升自己的編程能力和團(tuán)隊(duì)合作能力有很大的益處。

1. 文件注釋

源文件的開頭需要注釋說(shuō)明當(dāng)前的文件信息，包括文件名、作者、版本信息、日期、修改記錄等。

/*

* -----------------------------------------------------------------

* Copyright (C) 2007-2014, by HuaShengRun, Shenzhen, All rights reserved.

* -----------------------------------------------------------------

*

* File: RequestManager.java

* Author: JiongBull

* Version: 1.0

* Create: 2014-8-10

*

* Changes (from 2014-8-10)

* -----------------------------------------------------------------

* 2014-8-10 : 創(chuàng)建 RequestManager.java (JiongBull);

* -----------------------------------------------------------------

*/

2. 類注釋

在類的開頭添加類信息的描述.

/**

* 管理Volley的Request, 使用之前需要調(diào)用init()進(jìn)行初始化.

*/

public class RequestManager {

}

3. 方法注釋

一般情況下需要為每個(gè)方法添加注釋，包括方法的功能描述，參數(shù)信息、返回值、異常信息等，有些約定俗成的方法可以不需要添加注釋，請(qǐng)參考約定俗成的說(shuō)明。

/**

* 輸出日志.

*

* @param context Context

* @param logLevel 日志等級(jí)

* @param tag 標(biāo)簽

* @param content 輸出內(nèi)容

* @param throwable 異常信息, 若沒有異常可為空

*/

private static void trace(final Context context, final int logLevel, final String tag, final String content, final Throwable throwable) {

...

}

4. 域變量和常量注釋

/**

* 日志的擴(kuò)展名.

*/

public static final String LOG_EXTENSION = .log;

/**

* 網(wǎng)絡(luò)請(qǐng)求隊(duì)列.

*/

private RequestQueue mRequestQueue;

5. 其他注釋

單行注釋

view.setImageResource(defaultImageResId); // 無(wú)圖片顯示默認(rèn)圖片

區(qū)塊注釋

/* 網(wǎng)絡(luò)圖片添加漸變動(dòng)畫 */

Resources resource = mContext.getResources();

final TransitionDrawable transitionDrawable =

new TransitionDrawable(new Drawable[] {

new ColorDrawable(android.R.color.transparent),

new BitmapDrawable(resource, bmpResponse)

});

view.setBackgroundResource(defaultImageResId);

view.setImageDrawable(transitionDrawable);

transitionDrawable.startTransition(RequestManager.FADE_IN_TIME);

6. XML注釋

約定俗成

1. get / set 方法的注釋

通過(guò)IDE工具批量生成域變量的 get / set 方法可以不用注釋。

2. 第三方庫(kù)生成代碼的注釋

第三方庫(kù)生成的代碼可以不用注釋，例如greenDao生成的代碼。

3. 通用類的注釋

通用類的公共方法應(yīng)全部添加注釋。

4. 一般情況下的注釋

例如在activity、service等文件中，只需對(duì)關(guān)鍵的類變量進(jìn)行注釋，方法建議全部添加注釋。