【Android】【基礎(chǔ)篇】編碼規(guī)范

寫在前面:

不論是哪種語(yǔ)言虫碉,規(guī)范的編碼總能準(zhǔn)確描述表達(dá)的含義贾惦,讓人較容易明白,好的代碼規(guī)范能夠省去很多注釋,提高同事之間的工作效率须板。

下面就總結(jié)一下我平時(shí)用到的代碼規(guī)范碰镜。


先介紹兩種命名規(guī)則:

駝峰命名法:又稱小駝峰命名法。除了首個(gè)單詞首字母小寫除外习瑰,其余所有單詞所有首字母都要大寫绪颖。

帕斯卡命名法:又稱大駝峰命名法。所有單詞首字母大寫甜奄。


1柠横、包的命名規(guī)范

所有單詞小寫,只能包含a-z字母课兄,或有含義的阿拉伯?dāng)?shù)字如4代替for,2代替to

建議采用如下規(guī)則:【com】.【公司名/組織名】.【項(xiàng)目名稱】.【模塊名】

常見(jiàn)的包分層結(jié)構(gòu)如下:

com.xxx.xxx.view –> 自定義view 或者是View接口

com.xxx.xxx.activities –> activity類

com.xxx.xxx.fragments –> fragment類

com.xxx.xxx.adapter –> 適配器相關(guān)

com.xxx.xxx.utils –> 公共工具類

com.xxx.xxx.bean –> 實(shí)體類

com.xxx.xxx.service –> service服務(wù)

com.xxx.xxx.broadcast –> 廣播接收器

com.xxx.xxx.db –>數(shù)據(jù)庫(kù)操作類

com.xxx.xxx.persenter –> 中間對(duì)象

com.xxx.xxx.model –> 數(shù)據(jù)處理類


2滓鸠、類的命名規(guī)范

首字母大寫,大駝峰命名法第喳,使用名詞糜俗。

Activity ? ? ? ? ? ? ? ? ? ? ? ?類Activity為后綴標(biāo)識(shí) ? ? ? ? ? ? ? ?

Adapter類 ? ? ? ? ? ? ? ? ? ?Adapter 為后綴標(biāo)識(shí) ? ? ? ? ? ? ?

解析類 ? ? ? ? ? ? ? ? ? ? ? ? Parser為后綴標(biāo)識(shí) ? ? ? ? ? ? ? ? ??

工具方法類 ? ? ? ? ? ? ? ? ?Util或Manager為后綴標(biāo)識(shí) ? ? ?

管理類 ? ? ? ? ? ? ? ? ? ? ? ? Manager為后綴標(biāo)識(shí) ? ? ? ? ? ? ? ??

Service類 ? ? ? ? ? ? ? ? ? ?以Service為后綴標(biāo)識(shí)?

Receiver類 ? ? ? ? ? ? ? ? ?以Receiver為后綴標(biāo)識(shí)

ContentProvider ? ? ? ? ?以Provider為后綴標(biāo)識(shí)

自定義基類 ? ? ? ? ? ? ? ? ?以Base開(kāi)頭

自定義view ? ? ? ? ? ? ? ? ?功能描述 + View

自定義widget ? ? ? ? ? ? ? 模塊名 + 類型(List/Info) + Widget


3、常量命名

所有單詞大寫曲饱,單詞間以”_“分隔


4悠抹、變量命名

駝峰命名。成員變量以m開(kāi)頭扩淀;靜態(tài)變量以s開(kāi)頭


5楔敌、方法命名

與java開(kāi)發(fā)類似,采用駝峰命名規(guī)則驻谆。首單詞首字母小寫卵凑,其余單詞首字母大寫。盡量不要使用下劃線胜臊。

6勺卢、資源文件

1)布局文件

Activity-------------------activity_

Fragment-------------------fragment_

Dialog-------------------dialog_

PopupWindow-------------------popup_

Menu-------------------menu_

Adapter-------------------layout_item_

(2)圖片

bg_xxx-------------------背景圖片

btn_xx-------------------按鈕

ic_xxx-------------------單個(gè)圖標(biāo)

bg _ 描述 _ 狀態(tài)-------------------控件上的不同狀態(tài)

btn _ 描述 _ 狀態(tài)-------------------按鈕上的不同狀態(tài)

chx _ 描述 _ 狀態(tài)-------------------選擇框,一般2態(tài)或4態(tài)

(3)anim目錄下的命名規(guī)范

單詞全部小寫象对,單詞之間采用下劃線分割黑忱。

fade_in.xml

fade_out.xml

slide_in_from_left.xml

slide_in_from_top.xml

slide_out_to_right.xml

slide_out_to_bottom.xml



目前收集到的結(jié)合平時(shí)自己的使用習(xí)慣大概就這些,好的命名規(guī)范是一項(xiàng)重要的技能勒魔,可以在團(tuán)隊(duì)合作中可以很大限度減少溝通成本甫煞。無(wú)規(guī)范不成方圓。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末冠绢,一起剝皮案震驚了整個(gè)濱河市抚吠,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌弟胀,老刑警劉巖楷力,帶你破解...
    沈念sama閱讀 217,657評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件蕊玷,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡弥雹,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,889評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門延届,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)剪勿,“玉大人,你說(shuō)我怎么就攤上這事方庭〔藜” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,057評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵械念,是天一觀的道長(zhǎng)头朱。 經(jīng)常有香客問(wèn)我,道長(zhǎng)龄减,這世上最難降的妖魔是什么项钮? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,509評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮希停,結(jié)果婚禮上烁巫,老公的妹妹穿的比我還像新娘。我一直安慰自己宠能,他們只是感情好亚隙,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,562評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著违崇,像睡著了一般阿弃。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上羞延,一...
    開(kāi)封第一講書(shū)人閱讀 51,443評(píng)論 1 302
  • 那天渣淳,我揣著相機(jī)與錄音,去河邊找鬼伴箩。 笑死水由,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的赛蔫。 我是一名探鬼主播砂客,決...
    沈念sama閱讀 40,251評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼呵恢!你這毒婦竟也來(lái)了鞠值?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,129評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤渗钉,失蹤者是張志新(化名)和其女友劉穎彤恶,沒(méi)想到半個(gè)月后钞钙,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,561評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡声离,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,779評(píng)論 3 335
  • 正文 我和宋清朗相戀三年芒炼,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了轨奄。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片坟募。...
    茶點(diǎn)故事閱讀 39,902評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡细办,死狀恐怖台丛,靈堂內(nèi)的尸體忽然破棺而出朝巫,到底是詐尸還是另有隱情溃列,我是刑警寧澤食零,帶...
    沈念sama閱讀 35,621評(píng)論 5 345
  • 正文 年R本政府宣布辜羊,位于F島的核電站笋除,受9級(jí)特大地震影響斜友,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜垃它,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,220評(píng)論 3 328
  • 文/蒙蒙 一鲜屏、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧国拇,春花似錦墙歪、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,838評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至掉瞳,卻和暖如春毕源,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背陕习。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,971評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工霎褐, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人该镣。 一個(gè)月前我還...
    沈念sama閱讀 48,025評(píng)論 2 370
  • 正文 我出身青樓冻璃,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親损合。 傳聞我的和親對(duì)象是個(gè)殘疾皇子省艳,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,843評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • 文章來(lái)自https://github.com/Blankj/AndroidStandardDevelop#安卓開(kāi)發(fā)...
    小莊bb閱讀 756評(píng)論 0 1
  • Android編碼規(guī)范 源文件基礎(chǔ) 文件名 源文件以其最頂層的類名來(lái)命名,大小寫敏感嫁审,文件擴(kuò)展名為.java跋炕。 文...
    呼呼哥閱讀 941評(píng)論 0 0
  • Java類類名:大駝峰命名,所有單詞首寫字母大寫律适,并且類名最好為名詞.正確public class People{...
    WilsonMing閱讀 772評(píng)論 0 2
  • 作者:李旺成 時(shí)間:2016年4月3日 1. 前言 這份文檔參考了 Google Java 編程風(fēng)格規(guī)范和 Goo...
    diygreen閱讀 39,908評(píng)論 19 224
  • written by leo.wang Android代碼開(kāi)發(fā)規(guī)范 1 類聲明 1.1 只有一個(gè)頂級(jí) 類聲明每個(gè)頂...
    Poseidon_Wang閱讀 650評(píng)論 0 0