android命名規(guī)范和編碼規(guī)范

前言

大家或許都有接手過別人的代碼,最大的共同感悟就是:這代碼寫得真爛L愦小!命令混亂锄列、文件隨意存放图云,xml文件中夾帶著中文,class中有class邻邮,activity中帶adapter等等竣况。單理清這個項目脈絡就要花上個一個星期。但反思自己筒严,是不是也曾是(甚至現(xiàn)在還是)自己心里痛罵過千遍的那個人丹泉,自己是不是也在犯著同樣的錯誤?最近在閱讀包老師的《APP啟示錄》里面第4章有提及命令規(guī)范和編碼規(guī)范鸭蛙,就抄錄到這里摹恨,方便自己查閱,也期望能給大家提供些許幫助娶视。

命名規(guī)范

1.Java類命名規(guī)范

? ? ?a.Activity命名規(guī)范:以Activity作為后綴晒哄,如:HomeActivity;

? ? ?b.Adapter命名規(guī)范:以Adapter作為后綴肪获,如:PersonAdapter寝凌;

? ? ?c.Entity命名規(guī)范:以Entity作為后綴,如:CustomerEntity;

2.資源文件命名規(guī)范

? ?layout目錄下的資源文件命名規(guī)范:

? ? ? a.頁面布局文件:以act_為前綴,以activity所在的package作為中綴孝赫,以activity名稱作為后綴(切除activity)较木。注意:全部都用小寫。如:act_activity_addcustomer.xml

? ? ? b.listView中的item布局文件:以item作為固定前綴青柄,列表項的名稱作為后綴伐债。注意:都是小寫。如:item_lv_userlist.xml

? ? ? c.dialog布局文件:以dig_作為前綴刹前,Dialog的功能名稱作為后綴泳赋,注意:都是小寫。如:dig_err_message.xml

? ? drawable目錄下的文件命名規(guī)范:

? ? ? ?a.對于只有一個頁面使用的資源:以該頁面的名稱作為前綴喇喉。

? ? ? ?b.對于在一個模塊下多個頁面使用的資源:以該模塊的名稱作為前綴祖今。

? ? ? ?c.對于在各個模塊、各個頁面都有可能用到的資源,以common作為前綴千诬。

? 3.Java類中控件對象的命名規(guī)范&Layout中控件對象的ID命名規(guī)范

? ? ?控件類型+控件的邏輯名稱(首字母大寫)耍目,如登錄按鈕:btnLogin.

? ?4.strings.xml中常量的命名規(guī)范

? ? 這里面的值大多數(shù)是在layout的控件上使用,所以以該常量所在的activity名稱作為前綴徐绑,后面接空間名稱邪驮,再后面就自由發(fā)揮了,如:loginActivity_btnLogin_text

? ? 5.常量命名

? ? 只能包含字母和下劃線傲茄,字母全部大寫毅访。

編碼規(guī)范

? ? 1.分門別類存放各種類:


分門別類存放各種類

? ? 2.layout中用到的常量,都要在strings.xml中定義盘榨。

? ? 3.layout中所有控件的字體大小喻粹,都定義在dimens.xml中。這樣做的好處是草巡,只要稍微改變一下dimens.xml中的定義守呜,就可以批量修改頁面的樣式。

? ? 4.activity的onCreate拆分為以下三部分(遵循單一職責原則):

? ? ? ? ? a. initVariables:初始化變量(包括Intent上的數(shù)據(jù)和activity內部使用的變量)

? ? ? ? ? b. ?initViews:加載layout布局文件山憨,初始化控件查乒。

? ? ? ? ? c.loadData:調用MobileAPI

? ?5.使用fastJSON自定義實體作為MobileAPI的數(shù)據(jù)載體

? ?6.頁面之間傳值,使用Intent攜帶序列化實體數(shù)據(jù)的方式郁竟。

? ?7.為控件添加事件玛迄,統(tǒng)一使用如下形式:


控件事件

? ?8.activity中不要嵌套內部類

? ?9.Adapter綁定的數(shù)據(jù),統(tǒng)一采用ArrayList<自定義可序列化實體>

? 10為節(jié)省內存枪孩,請使用ArrayList<自定義實體>憔晒,而不是HashMap.

? 11.圖片的處理,統(tǒng)一采用第三方組件ImageLoader或Fresco.

? 12.簡單的配置信息蔑舞、設置頁面的各種開關使用SharePreferences存儲拒担。

? 13.盡量使用ApplicationContext代替Context,避免內存泄露攻询。

目的

做這些規(guī)范从撼,根本目的就是要統(tǒng)一一個團隊的編碼習慣,使一個項目中的代碼钧栖,看上去都像是一個人寫的低零。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市拯杠,隨后出現(xiàn)的幾起案子掏婶,更是在濱河造成了極大的恐慌,老刑警劉巖潭陪,帶你破解...
    沈念sama閱讀 218,941評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件雄妥,死亡現(xiàn)場離奇詭異最蕾,居然都是意外死亡,警方通過查閱死者的電腦和手機老厌,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,397評論 3 395
  • 文/潘曉璐 我一進店門瘟则,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人枝秤,你說我怎么就攤上這事醋拧。” “怎么了淀弹?”我有些...
    開封第一講書人閱讀 165,345評論 0 356
  • 文/不壞的土叔 我叫張陵丹壕,是天一觀的道長。 經常有香客問我垦页,道長雀费,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,851評論 1 295
  • 正文 為了忘掉前任痊焊,我火速辦了婚禮,結果婚禮上忿峻,老公的妹妹穿的比我還像新娘薄啥。我一直安慰自己,他們只是感情好逛尚,可當我...
    茶點故事閱讀 67,868評論 6 392
  • 文/花漫 我一把揭開白布垄惧。 她就那樣靜靜地躺著,像睡著了一般绰寞。 火紅的嫁衣襯著肌膚如雪到逊。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,688評論 1 305
  • 那天滤钱,我揣著相機與錄音觉壶,去河邊找鬼。 笑死件缸,一個胖子當著我的面吹牛铜靶,可吹牛的內容都是我干的。 我是一名探鬼主播他炊,決...
    沈念sama閱讀 40,414評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼争剿,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了痊末?” 一聲冷哼從身側響起蚕苇,我...
    開封第一講書人閱讀 39,319評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎凿叠,沒想到半個月后涩笤,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體嚼吞,經...
    沈念sama閱讀 45,775評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年辆它,在試婚紗的時候發(fā)現(xiàn)自己被綠了誊薄。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,096評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡锰茉,死狀恐怖呢蔫,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情飒筑,我是刑警寧澤片吊,帶...
    沈念sama閱讀 35,789評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站协屡,受9級特大地震影響俏脊,放射性物質發(fā)生泄漏。R本人自食惡果不足惜肤晓,卻給世界環(huán)境...
    茶點故事閱讀 41,437評論 3 331
  • 文/蒙蒙 一爷贫、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧补憾,春花似錦漫萄、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,993評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至削饵,卻和暖如春岩瘦,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背窿撬。 一陣腳步聲響...
    開封第一講書人閱讀 33,107評論 1 271
  • 我被黑心中介騙來泰國打工启昧, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人尤仍。 一個月前我還...
    沈念sama閱讀 48,308評論 3 372
  • 正文 我出身青樓箫津,卻偏偏與公主長得像,于是被迫代替她去往敵國和親宰啦。 傳聞我的和親對象是個殘疾皇子苏遥,可洞房花燭夜當晚...
    茶點故事閱讀 45,037評論 2 355

推薦閱讀更多精彩內容