Android代碼規(guī)范總結

image.png

每當看到github上優(yōu)秀的項目代碼時,那簡直就比掏耳朵還享受褥伴。寫代碼如同寫文章谅将,代碼時開發(fā)者的顏值,正所謂沒有丑女人重慢,只有懶女人饥臂,漂亮的代碼也需要我們去精心裝飾。簡潔規(guī)范的代碼對個人似踱,對團隊隅熙,對下一個代碼接盤者,是一種責任核芽,也是一種專業(yè)的體現(xiàn)囚戚。

命名規(guī)范:

  • 類的命名:使用大駝峰法,同時需要根據(jù)類的作用引入Android相關命名規(guī)則轧简,使用類的類型作為前綴或后綴驰坊,示例:
    Activity類:xxxActivity
    Fragment類:xxxFragment
    Service類:xxxService
    工具類:xxxUtil
    Adapter類,xxxAdapter
    基類哮独,Basexxx

  • 布局文件命名:
    布局文件命名規(guī)則使用“前綴_邏輯名”方式拳芙,單詞全小寫,示例:
    Activity布局文件命名:activity_xxx
    Fragment布局文件命名:fragment_xxx
    自定義控件布局文件命名:view_xxx
    Dialog布局文件命名:dialog_xxx
    列表項布局文件命名:item_xxx

  • 資源文件命名:
    資源文件命名規(guī)則使用“前綴模塊名功能名”方式借嗽,單詞全小寫态鳖,示例:
    我的個人設置textview,用tv_me_setting
    登錄按鈕恶导,用btn_login
    圖標命名以ic為前綴浆竭,形如ic_xxx
    背景圖片命名以bg為前綴,形如bg_xxx
    背景樣式shape形如shape_xxx
    背景選擇器selector形如selector_xxx

  • 命名結構

  1. 枚舉常量用逗號隔開惨寿,換行可選:
public enum NetWorkState {
    WIFI,MOBILE,NONE;
}
  1. 每次只聲明一個變量:
    不要組合聲明變量邦泄,例如int num,max;這樣影響閱讀。

  2. 數(shù)據(jù)初始化:可寫成塊狀結構裂垦,例如

new int[] {
        0, 1, 2, 3 
}
new int[] {
        0,
        1,
        2,
        3
}
  • 變量和常量
    變量名的命名使用小駝峰法lowerCamelCase顺囊。常量名使用大寫字母,單詞用下劃線分割蕉拢,例如public static final int REQUEST_OK = 200特碳。

  • 臨時變量
    變量i,j晕换,k通常用于循環(huán)計數(shù)午乓;變量m,n通常用于整形闸准;c益愈,d,e通常用于字符型。

  • 常用英文單詞縮寫:

名稱 縮寫
icon ic
average avg
background bg
delete del
document doc
error err
increment inc
infomation info
initial init
image img
length len
library lib
message msg
password pwd
position pos
string str
  • 不要使用拼音來命名蒸其,不知道英文單詞就及時使用翻譯敏释。

代碼書寫規(guī)范:

  • 多使用花括號:
    if,else摸袁,for等語句和花括號一起使用钥顽,即使只有一條語句,也要加上花括號靠汁。
if(allowed)
    todo();
else
    back();

不建議這樣寫耳鸯,這樣可能給人誤導。
正確做法應為:

if(allowed){
    todo();
}else{
    back();
}
  • 每行字符個數(shù)限制在80—100個之間

  • 空白的使用:符號之間應用一個空格隔開膀曾;一段代碼內县爬,不要都擠在一起,而應該按照邏輯分組添谊,用空行隔開财喳,使邏輯更加清晰。

  • 修飾符的順序:類和成員的修飾符如果存在多個斩狱,需要按照Java規(guī)范的定義排序耳高,順序如下:
    public protected private abstract static final transient volatile synchronized native

  • 方法的注釋:

/**
     * 功能描述
     * @param 參數(shù)說明
     * @return 返回值說明
     * @author 模塊的作者
     */
private void function(){
}
  • 類的注釋:在創(chuàng)建類時標注好作者,創(chuàng)建時間所踊,聯(lián)系方法泌枪,類功能等信息
/**
 * Created by libo on 2017/12/25.
 * email:
 * 單聊
 */

該文章持續(xù)總結,持續(xù)更新秕岛。

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末碌燕,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子继薛,更是在濱河造成了極大的恐慌修壕,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,590評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件遏考,死亡現(xiàn)場離奇詭異慈鸠,居然都是意外死亡,警方通過查閱死者的電腦和手機灌具,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,157評論 3 399
  • 文/潘曉璐 我一進店門青团,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人咖楣,你說我怎么就攤上這事督笆。” “怎么了截歉?”我有些...
    開封第一講書人閱讀 169,301評論 0 362
  • 文/不壞的土叔 我叫張陵胖腾,是天一觀的道長烟零。 經常有香客問我瘪松,道長咸作,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 60,078評論 1 300
  • 正文 為了忘掉前任宵睦,我火速辦了婚禮记罚,結果婚禮上,老公的妹妹穿的比我還像新娘壳嚎。我一直安慰自己桐智,他們只是感情好,可當我...
    茶點故事閱讀 69,082評論 6 398
  • 文/花漫 我一把揭開白布烟馅。 她就那樣靜靜地躺著说庭,像睡著了一般。 火紅的嫁衣襯著肌膚如雪郑趁。 梳的紋絲不亂的頭發(fā)上刊驴,一...
    開封第一講書人閱讀 52,682評論 1 312
  • 那天,我揣著相機與錄音寡润,去河邊找鬼捆憎。 笑死,一個胖子當著我的面吹牛梭纹,可吹牛的內容都是我干的躲惰。 我是一名探鬼主播,決...
    沈念sama閱讀 41,155評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼变抽,長吁一口氣:“原來是場噩夢啊……” “哼础拨!你這毒婦竟也來了?” 一聲冷哼從身側響起绍载,我...
    開封第一講書人閱讀 40,098評論 0 277
  • 序言:老撾萬榮一對情侶失蹤太伊,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后逛钻,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體僚焦,經...
    沈念sama閱讀 46,638評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 38,701評論 3 342
  • 正文 我和宋清朗相戀三年曙痘,在試婚紗的時候發(fā)現(xiàn)自己被綠了芳悲。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,852評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡边坤,死狀恐怖名扛,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情茧痒,我是刑警寧澤肮韧,帶...
    沈念sama閱讀 36,520評論 5 351
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響弄企,放射性物質發(fā)生泄漏超燃。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 42,181評論 3 335
  • 文/蒙蒙 一拘领、第九天 我趴在偏房一處隱蔽的房頂上張望意乓。 院中可真熱鬧,春花似錦约素、人聲如沸届良。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,674評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽士葫。三九已至,卻和暖如春送悔,著一層夾襖步出監(jiān)牢的瞬間为障,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,788評論 1 274
  • 我被黑心中介騙來泰國打工放祟, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留鳍怨,地道東北人。 一個月前我還...
    沈念sama閱讀 49,279評論 3 379
  • 正文 我出身青樓跪妥,卻偏偏與公主長得像鞋喇,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子眉撵,可洞房花燭夜當晚...
    茶點故事閱讀 45,851評論 2 361

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,322評論 25 707
  • Android編碼規(guī)范 源文件基礎 文件名 源文件以其最頂層的類名來命名侦香,大小寫敏感,文件擴展名為.java纽疟。 文...
    呼呼哥閱讀 952評論 0 0
  • 第一部分 打好基礎 Laying the Foundation 第一章 歡迎進入軟件構建的世界 Welcome t...
    白樺葉閱讀 4,639評論 0 17
  • 歲月長河的波浪奔流前行罐韩,總會帶走一些陳舊的,已被淘汰的舊事物污朽,送來一些適合的散吵,符合時代潮流的新事。這是誰也無法改變...
    補拙莫如勤LV閱讀 1,751評論 0 1
  • 天黑后適合看電影蟆肆。鉆在被子里看心緒更是自由矾睦。 昨晚看完殺人回憶已過1點。 一個多小時的冷色調里炎功,仿佛小鎮(zhèn)里只剩下雨...
    遠行燈閱讀 306評論 1 0