Android 編程規(guī)范

架構(gòu)&分包 -- 原則

  • 包名應(yīng)讓人一目知意:英文命名描述其功能荒辕。
  • 分包層次應(yīng)盡可能的低汗销,減短包名長度。
  • Model層(業(yè)務(wù)數(shù)據(jù)管理層兄纺,APP核心)大溜,View層(視圖層)應(yīng)該盡量分開,Model層單獨(dú)管理數(shù)據(jù)估脆, 不應(yīng)與其他的模塊耦合钦奋。
  • 按照功能模塊進(jìn)行分包。如:MVP架構(gòu)模式下疙赠,可以按照Model付材,View,Presenter 分成三個(gè)大的模塊包圃阳,在三個(gè)大的模塊下在細(xì)分功能包厌衔。APP的一些基類或者說通用的技術(shù)打包成一個(gè)Moudule,作為技術(shù)沉淀捍岳,方便大家學(xué)習(xí)和其他APP使用富寿。如:JCourse中的common,同時(shí)建議在制作的通用技術(shù)module包足夠成熟時(shí)锣夹,打包成aar页徐,并上傳到meven,通過gradle遠(yuǎn)程依賴银萍。
MVP按照功能模塊分包
通用技術(shù)Common

命名規(guī)則

禁止拼音命名变勇,必須是英文有意義的單詞,簡單知意。

java文件

  • java類名,接口名:駝峰法命名僚饭,單詞首字母全部大寫
  • 成員變量名:m開頭 + 駝峰法命名
  • 常量:全部字母大寫义郑,單詞之間用下劃線(_)連接
  • activity和fragment:模塊包名 + activity/fragment + 功能名

xml文件

  • 布局文件:模塊包名 _ activity/fragment _ 功能名
  • 布局文件中變量:字母全部小寫,單詞之間用下劃線(_)連接,取名以功能和view相結(jié)合的方式
  • 布局文件中控件的大小需要寫在資源文件里(dimens.xml),做好兼容性。
  • menu:模塊包名 _ activity/fragment _ 功能名(和布局對(duì)應(yīng))
  • style:駝峰法命名锣险,單詞首字母全部大寫
  • color:分為兩部分(1):先以顏色色彩命名蹄皱,駝峰法,首字母小寫芯肤。
    (2)根據(jù)具體功能重新生成一個(gè)<color/>標(biāo)簽巷折,根據(jù)對(duì)應(yīng)的功能命名,并以color開頭崖咨,駝峰法锻拘。

drawable

類型_功能

  • icon:ic _ 功能名
  • menu中使用的icon:ic_menu_功能名
  • 背景:bg_功能名
xml命名,更加對(duì)應(yīng)的功能模塊名快速查找
drawble命名

編碼

  • 在自己負(fù)責(zé)的功能模塊下開發(fā)击蹲,如有新功能模塊署拟,建立新的分包。
  • 在自己寫的每個(gè)文件寫好注釋和作者歌豺。

文案

  • 寫完代碼后在README.md文件中寫好文件名及對(duì)應(yīng)的解釋推穷,作者。
    如:MainActivity -> 主頁面 linlongxin类咧,方便后期查找馒铃,有問題更容易找到作者。

其他

開發(fā)中大部分情況下是多人團(tuán)隊(duì)合作痕惋,每個(gè)成員的編碼風(fēng)格經(jīng)過上面規(guī)則可以得到統(tǒng)一区宇,但是對(duì)于邏輯的處理,架構(gòu)的選擇(如:mvp值戳,mvc)也應(yīng)該統(tǒng)一议谷,在每次提交代碼后,應(yīng)該由技術(shù)團(tuán)隊(duì)技術(shù)當(dāng)擔(dān)來審核代碼的規(guī)范性堕虹。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末卧晓,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子赴捞,更是在濱河造成了極大的恐慌禀崖,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,214評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件螟炫,死亡現(xiàn)場離奇詭異,居然都是意外死亡艺晴,警方通過查閱死者的電腦和手機(jī)昼钻,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,307評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來封寞,“玉大人然评,你說我怎么就攤上這事”肪浚” “怎么了碗淌?”我有些...
    開封第一講書人閱讀 152,543評(píng)論 0 341
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我亿眠,道長碎罚,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,221評(píng)論 1 279
  • 正文 為了忘掉前任纳像,我火速辦了婚禮荆烈,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘竟趾。我一直安慰自己憔购,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,224評(píng)論 5 371
  • 文/花漫 我一把揭開白布岔帽。 她就那樣靜靜地躺著玫鸟,像睡著了一般。 火紅的嫁衣襯著肌膚如雪犀勒。 梳的紋絲不亂的頭發(fā)上屎飘,一...
    開封第一講書人閱讀 49,007評(píng)論 1 284
  • 那天,我揣著相機(jī)與錄音账蓉,去河邊找鬼枚碗。 笑死,一個(gè)胖子當(dāng)著我的面吹牛铸本,可吹牛的內(nèi)容都是我干的肮雨。 我是一名探鬼主播,決...
    沈念sama閱讀 38,313評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼箱玷,長吁一口氣:“原來是場噩夢啊……” “哼怨规!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起锡足,我...
    開封第一講書人閱讀 36,956評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤波丰,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后舶得,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體掰烟,經(jīng)...
    沈念sama閱讀 43,441評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,925評(píng)論 2 323
  • 正文 我和宋清朗相戀三年沐批,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了纫骑。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,018評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡九孩,死狀恐怖先馆,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情躺彬,我是刑警寧澤煤墙,帶...
    沈念sama閱讀 33,685評(píng)論 4 322
  • 正文 年R本政府宣布梅惯,位于F島的核電站,受9級(jí)特大地震影響仿野,放射性物質(zhì)發(fā)生泄漏铣减。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,234評(píng)論 3 307
  • 文/蒙蒙 一设预、第九天 我趴在偏房一處隱蔽的房頂上張望徙歼。 院中可真熱鬧,春花似錦鳖枕、人聲如沸魄梯。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,240評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽酿秸。三九已至,卻和暖如春魏烫,著一層夾襖步出監(jiān)牢的瞬間辣苏,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,464評(píng)論 1 261
  • 我被黑心中介騙來泰國打工哄褒, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留稀蟋,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,467評(píng)論 2 352
  • 正文 我出身青樓呐赡,卻偏偏與公主長得像退客,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子链嘀,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,762評(píng)論 2 345

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

  • 參考資料:我總結(jié)的Android編程規(guī)范 1. 命名規(guī)則 1.1 類名萌狂,接口名: 以大寫開頭,如果一個(gè)類的類名由多...
    Coder_Y閱讀 2,785評(píng)論 12 60
  • 前言 通過建立代碼編寫規(guī)范怀泊,形成Android編碼約定茫藏,提高程序的可靠性、可讀性霹琼、可修改性务傲、可維護(hù)性、一致性枣申,保證...
    yabin小站閱讀 1,170評(píng)論 1 13
  • 命名規(guī)范 1. 基本原則 (1) 代碼風(fēng)格與android源碼保持一致(2) 命名要清晰明了树灶、有明確含義(3) ...
    Brian512閱讀 573評(píng)論 0 5
  • 文章來自https://github.com/Blankj/AndroidStandardDevelop#安卓開發(fā)...
    小莊bb閱讀 747評(píng)論 0 1
  • 做好你自己,堅(jiān)強(qiáng)勇敢自信一些糯而,所有的相遇都是有緣分的,所以擁抱生活中的一切泊窘,隨著你的心走吧熄驼,是或是不是像寒,也許很快就...
    慕容一一閱讀 100評(píng)論 0 0