Carson帶你學(xué)Android:你不能忽略的代碼命名規(guī)范

前言

  • Android代碼規(guī)范內(nèi)容非常多,但對我們最有用& 最有影響的莫過于 Android代碼的命名規(guī)范
  • 可是朴艰,有很多人容易忽略Android代碼的命名規(guī)范蛮艰,從而導(dǎo)致代碼的可讀性 & 維護(hù)性非常差眼虱,最終導(dǎo)致開發(fā)效率 & 維護(hù)效率降低
  • 今天,我將根據(jù) Google Java 編程規(guī)范 & Google 官方 Android 編碼規(guī)范汉买,為大家?guī)?strong>一份全面 & 清晰的Android代碼命名規(guī)范,希望你們會喜歡佩脊。

目錄

示意圖

1. 為什么 規(guī)范 Android 代碼命名蛙粘?

  • 增強(qiáng)代碼的可讀性
  • 增強(qiáng)代碼的可維護(hù)性

正由于上述兩個作用垫卤,從而使得 開發(fā)效率 & 維護(hù)效率 得到大幅度的提高。


2. Android需要命名的代碼(對象)有哪些组题?

示意圖

3. 具體命名規(guī)范

下面葫男,我將對 Android 代碼對象中的命名規(guī)范進(jìn)行詳細(xì)講解

注:由于 Android主要用Java實(shí)現(xiàn),所以Android規(guī)范會涵蓋部分Java規(guī)范

3.1 包

  • 基礎(chǔ)規(guī)則:小寫崔列、單詞間連續(xù)無間隔梢褐、反域名法(分為4級,具體如下圖)
示意圖
  • 第4級包名會隨著功能的不同而不同赵讯。下面我列舉出一些常見 & 需要規(guī)范的4級功能包名
示意圖

3.2 類

  • 基礎(chǔ)規(guī)則
    1. 類型 = 名詞 / 名詞短語盈咳;
    2. 形式 = 駝峰形式中的 大駱駝拼寫法UpperCamelCase

即名稱中的每個詞的首字母都大寫,如 AndroidStudio

  • 在具體命名類時边翼,會根據(jù) 該類的類型不同而附加額外的命名規(guī)則鱼响。具體如下圖
示意圖

3.3 變量

  • 基礎(chǔ)規(guī)則
    1. 類型 = 名詞 / 名詞短語;
    2. 形式 = 駝峰形式中的 小駱駝拼寫法LowerCamelCase

即名稱中的第1個詞的首字母小寫组底,后面每個詞的首字母大寫丈积,如androidStudioTool

  • 在具體命名變量時,會根據(jù)該變量的類型不同而 附加額外的命名規(guī)則债鸡。具體如下圖
示意圖

3.4 方法

  • 基礎(chǔ)規(guī)則
    1. 類型 = 動詞 / 動詞短語江滨;
    2. 形式 = 駝峰形式中的 小駱駝拼寫法LowerCamelCase

即名稱中的第1個詞的首字母小寫,后面每個詞的首字母大寫厌均,如androidStudioTool

  • 在具體命名 方法名時唬滑,會根據(jù) 該方法名的作用不同而 附加額外的命名規(guī)則。具體如下圖
示意圖

3.5 參數(shù)名

  • 基礎(chǔ)規(guī)則:駝峰形式中的 小駱駝拼寫法LowerCamelCase

即名稱中的第1個詞的首字母小寫棺弊,后面每個詞的首字母大寫晶密,如androidStudioTool

  • 附加命名規(guī)則:功能名,如userName

3.6 資源

  • Android的資源包括:
示意圖
示意圖

下面模她,我將對每種Android資源的命名規(guī)則進(jìn)行詳細(xì)講解

3.6.1 布局文件資源

示意圖

3.6.2 圖片資源

示意圖

3.6.3 參數(shù)值資源

示意圖

3.6.4 動畫資源

示意圖

3.7 額外

除了上述的命名規(guī)范以外稻艰,Android 中還有一些全局通用的命名規(guī)范:

示意圖

至此,關(guān)于Android的代碼命名規(guī)范講解完畢


4. 附錄:常見使用單詞縮寫表

  • 使用單詞縮寫的原則:只使用約定俗成的單詞縮寫

嚴(yán)禁自由縮寫單詞

  • 具體如下圖
示意圖

5. 總結(jié)

  • 看完本文后缝驳,相信你以后會認(rèn)真對待 Android代碼命名了连锯!

  • 下一篇文章我將對講解Android 的相關(guān)知識,感興趣的同學(xué)可以繼續(xù)關(guān)注本人的簡書哦用狱。

相關(guān)系列文章閱讀
Carson帶你學(xué)Android:學(xué)習(xí)方法
Carson帶你學(xué)Android:四大組件
Carson帶你學(xué)Android:自定義View
Carson帶你學(xué)Android:異步-多線程
Carson帶你學(xué)Android:性能優(yōu)化
Carson帶你學(xué)Android:動畫


歡迎關(guān)注Carson_Ho的簡書

不定期分享關(guān)于安卓開發(fā)的干貨运怖,追求短、平夏伊、快摇展,但卻不缺深度


請點(diǎn)贊溺忧!因?yàn)槟愕墓膭钍俏覍懽鞯淖畲髣恿Γ?/h1>

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末咏连,一起剝皮案震驚了整個濱河市盯孙,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌祟滴,老刑警劉巖振惰,帶你破解...
    沈念sama閱讀 206,482評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異垄懂,居然都是意外死亡骑晶,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,377評論 2 382
  • 文/潘曉璐 我一進(jìn)店門草慧,熙熙樓的掌柜王于貴愁眉苦臉地迎上來桶蛔,“玉大人,你說我怎么就攤上這事漫谷∽欣祝” “怎么了?”我有些...
    開封第一講書人閱讀 152,762評論 0 342
  • 文/不壞的土叔 我叫張陵舔示,是天一觀的道長碟婆。 經(jīng)常有香客問我,道長惕稻,這世上最難降的妖魔是什么脑融? 我笑而不...
    開封第一講書人閱讀 55,273評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮缩宜,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘甥温。我一直安慰自己锻煌,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,289評論 5 373
  • 文/花漫 我一把揭開白布姻蚓。 她就那樣靜靜地躺著宋梧,像睡著了一般。 火紅的嫁衣襯著肌膚如雪狰挡。 梳的紋絲不亂的頭發(fā)上捂龄,一...
    開封第一講書人閱讀 49,046評論 1 285
  • 那天,我揣著相機(jī)與錄音加叁,去河邊找鬼倦沧。 笑死,一個胖子當(dāng)著我的面吹牛它匕,可吹牛的內(nèi)容都是我干的展融。 我是一名探鬼主播,決...
    沈念sama閱讀 38,351評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼豫柬,長吁一口氣:“原來是場噩夢啊……” “哼告希!你這毒婦竟也來了扑浸?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,988評論 0 259
  • 序言:老撾萬榮一對情侶失蹤燕偶,失蹤者是張志新(化名)和其女友劉穎喝噪,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體指么,經(jīng)...
    沈念sama閱讀 43,476評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡酝惧,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,948評論 2 324
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了涧尿。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片系奉。...
    茶點(diǎn)故事閱讀 38,064評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖姑廉,靈堂內(nèi)的尸體忽然破棺而出缺亮,到底是詐尸還是另有隱情,我是刑警寧澤桥言,帶...
    沈念sama閱讀 33,712評論 4 323
  • 正文 年R本政府宣布萌踱,位于F島的核電站,受9級特大地震影響号阿,放射性物質(zhì)發(fā)生泄漏并鸵。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,261評論 3 307
  • 文/蒙蒙 一扔涧、第九天 我趴在偏房一處隱蔽的房頂上張望园担。 院中可真熱鬧,春花似錦枯夜、人聲如沸弯汰。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,264評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽咏闪。三九已至,卻和暖如春摔吏,著一層夾襖步出監(jiān)牢的瞬間鸽嫂,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,486評論 1 262
  • 我被黑心中介騙來泰國打工征讲, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留据某,地道東北人。 一個月前我還...
    沈念sama閱讀 45,511評論 2 354
  • 正文 我出身青樓稳诚,卻偏偏與公主長得像哗脖,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,802評論 2 345

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

  • 食用注意(現(xiàn)在才寫_(:3」∠)) 原著世界描述不多山宾,現(xiàn)代架空ooc,狗血劇情多楞遏,原著中跟鳴人的最後一戰(zhàn)有茬暇。完全沒...
    莫鴆閱讀 4,616評論 2 6
  • 人生有一萬種可能,你只終于一種嘛寡喝? 遲山閑聽雨急落點(diǎn)花紅疑似蓬萊客御云送晚晴 清池雨點(diǎn)豆細(xì)露嬌芙蓉一葉纏曲莖信手剝蓮蓬
    青梅3煮酒閱讀 300評論 1 1
  • 除去今天糙俗,再過兩天就是新的一年-2017年。這一年的事情竟然好多都想不起來了预鬓。是我不愿意記憶吧巧骚,不管是高興的不高興...
    望飛雪閱讀 222評論 2 1
  • 摘要: Zookeeper集群安裝 SpringMVC+Mybatis, Dubbo+Zookeeper, jav...
    ITsupuerlady閱讀 173評論 0 0
  • 2016最后一天跟2016的前三百六十四天好像也沒有什么不同,但難能可貴的是201...
    朱想不通閱讀 400評論 6 6