Android 開發命名規范

一個好的開發規范,就是團隊合作的基石

阿里巴巴Java開發手冊(正式版)

Java 文件

采用駝峰命名法

文件頭

具體設置可以查看我的另外一篇文章

/**
 * @author gmf (可以寫固定的名稱或者使用計算機用戶名  ${USER})
 * @description 
 * @date ${DATE}.
 */

Activity

Activity 作為后綴,如:LoginActivity

Fragment

Fragment 作為后綴,如:UserFragment

Adapter

Adapter 作為后綴,如:CollectAdapter

常量

全部大寫,單詞之間用下劃線分開,如:

private final String CACHE_PATH = "cache_path";

靜態變量

首字母小寫,加前綴s,如:

private static String sName;

成員變量

首字母小寫,加前綴m,如:

private int mAge;

局部變量

首字母小寫,不用加前綴,如:

int age;

控件變量

Android的控件變量,采用“邏輯功能+控件縮寫”的形式,如:登陸按鈕 loginBtn

常見的控件縮寫對照表

組件名稱 縮寫
TextView Tv (tv)
ListView Lv (lv)
EditText Edt (edt)
CheckBox Chk (chk)
Button Btn (btn)
ImageButton Ibtn (ibtn)
ToggleButton Tbtn (tbtn)
RadioButton Rbtn (rbtn)
ImageView Iv (iv)
ProgressBar Pbar (pbar)
ScrollView Sclv (sclv)
LinearLayout Llyt (llyt)
RelativeLayout Rlyt (rlyt)
TableLayout Tlyt (tlyt)
FrameLayout Flyt (flyt)

這里有個小細節,變量聲明一般這樣,static 變量放在最前面,控件變量放中間,普通成員變量放在后面,示例如下:

// static 變量
private static final String PHOTO = "photo";

// 控件變量
private ImageView mPhotoIv;
private FloatingActionButton mEditFbtn;
private EditText mDescriptionEdt;
private EditText mAddressEdt;
private EditText mTimeEdt;
private EditText mCategoryEdt;

// 普通成員變量
private Photo mPhoto;

Android 資源文件

layout

1. 布局文件

格式:界面類型_模塊.xml / 界面類型_模塊_描述.xml

如:activity_login.xml, fragment_login.xml, dialog_login.xml

2. 列表項

格式:item_控件類型_功能描述 / item_控件類型_模塊_功能描述

如:item_lv_order.xml, item_gv_main_photo.xml

3. 包含項

格式:包含類型_模塊_描述 / 包含類型_控件類型_描述

如: merge_detail_footer.xml, include_refreshview_header.xml

4. 控件id

格式:模塊名_控件類型_描述

activity_category.xml 文件下顯示姓名的 TextView,其命名為 android:id="@+id/category_tv_name"

drawable

1. 靜態圖片

格式:
類型_common_描述:多個模塊共用
類型_模塊_描述:單個模塊共用
類型_模塊_描述_狀態:配合動態風格使用

ic_common_delete.png (刪除按鈕,多個模塊共用)
ic_accont_head.png(賬戶模塊下的頭像)
ic_theme_add_nomal.png (添加主題按鈕的正常狀態)
ic_theme_add_pressed.png (添加主題按鈕的被按下狀態)

2. 動態風格

格式:
common_描述:多個模塊共用
模塊_描述:單個某塊共用

common_delete.xml (共用)
theme_add.xml (添加主題按鈕)

string.xml

Java 文件和布局文件中,除了注釋可以是中文,其他文字性說明都要放入 string.xml 中統一管理,它們在 string.xml 中的命名規范如下:

1. xml

格式:
控件id:控件有聲明 id
模塊_描述:控件無聲明 id

<string name=”account_btn_login”>登錄</string>
<string name=”account_forget_pwd”>忘記密碼</string>

2. Java

格式:模塊_描述

新聞詳情頁,用戶點擊收藏時提示「已收藏」:

ToastUtil.show(getString(R.string.detail_collected));

colors.xml

只定義顏色表,colors.xml文件中只是映射顏色的一個RGBA值,而沒有其它的

糟糕的例子

<resources>
    <color name="listview_divider">#cfcfd2</color>
    <color name="listview_normal">#ffffff</color>
    <color name="listview_selected">#fafafa</color>
    <color name="actionbar_item_normal">#20699f</color>
    <color name="actionbar_item_selected">#105085</color>
</resources>

使用這種格式,你會非常容易的開始重復定義RGBA值,這使如果需要改變基本色變的很復雜。同時,這些定義是跟一些環境關聯起來的,如 button, 應該放到一個按鈕風格中,而不是在color.xml文件中。

好的例子

<resources>
    <!-- grayscale -->
    <color name="white">#FFFFFF</color>
    <color name="gray_light">#DBDBDB</color>
    <color name="gray">#939393</color>
    <color name="gray_dark" >#5F5F5F</color>

    <!-- basic colors -->
    <color name="green">#27D34D</color>
    <color name="blue">#2A91BD</color>
    <color name="orange">#FF9D2F</color>
    <color name="red">#FF432F</color>
</resources>

dimens.xml

像對待colors.xml一樣對待dimens.xml文件,看個好的例子:

<resources>
    <!-- font sizes -->
    <dimen name="font_larger">22sp</dimen>
    <dimen name="font_large">18sp</dimen>
    <dimen name="font_normal">15sp</dimen>
    <dimen name="font_small">12sp</dimen>

    <!-- typical spacing between two views -->
    <dimen name="spacing_huge">40dp</dimen>
    <dimen name="spacing_large">24dp</dimen>
    <dimen name="spacing_normal">14dp</dimen>
    <dimen name="spacing_small">10dp</dimen>
    <dimen name="spacing_tiny">4dp</dimen>

    <!-- typical sizes of views -->
    <dimen name="button_height_tall">60dp</dimen>
    <dimen name="button_height_normal">40dp</dimen>
    <dimen name="button_height_short">32dp</dimen>
</resources>

style.xml

Android中,styles這個文件名稱并沒有作用,起作用的是在文件里xml的 <style>標簽。因此你可以有多個style文件,如:

  • styles.xml
  • style_home.xml
  • styles_forms.xml
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,546評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,570評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,505評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,017評論 1 313
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,786評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,219評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,287評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,438評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,971評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,796評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,995評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,540評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,230評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,918評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,697評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374

推薦閱讀更多精彩內容

  • 還記得剛開始coding的時候,命名都是漢語拼音,所以有的時候想看懂它的意思,就要讀一遍甚至好幾遍才知道,這還是在...
    leo62閱讀 8,965評論 2 19
  • 本文為 Crocutax 原創 , 轉載請注明出處 http://www.crocutax.com 核心原則 見名...
    Crocutax閱讀 2,513評論 0 5
  • 這里統一使用的命名規則作為開發組內進行溝通使用,約定俗成,僅供參考。 英文縮寫原則 較短的單詞可通過去掉"元音"形...
    kuwork閱讀 4,189評論 0 20
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,661評論 25 708
  • 泛黃的紙張 寫滿狂妄的誓言 說要一起 牽手向前 撕裂的云朵 橫亙在天 似我曾 許諾的永遠 腳下無際的荒漠 你指著遼...
    我叫大象閱讀 382評論 6 4