Android 编程规范

架构&分包 -- 原则

  • 包名应让人一目知意:英文命名描述其功能
  • 分包层次应尽可能的低,减短包名长度。
  • Model层(业务数据管理层,APP核心),View层(视图层)应该尽量分开,Model层单独管理数据, 不应与其他的模块耦合。
  • 按照功能模块进行分包。如:MVP架构模式下,可以按照Model,View,Presenter 分成三个大的模块包,在三个大的模块下在细分功能包。APP的一些基类或者说通用的技术打包成一个Moudule,作为技术沉淀,方便大家学习和其他APP使用。如:JCourse中的common,同时建议在制作的通用技术module包足够成熟时,打包成aar,并上传到meven,通过gradle远程依赖。
MVP按照功能模块分包
通用技术Common

命名规则

禁止拼音命名,必须是英文有意义的单词,简单知意。

java文件

  • java类名,接口名:驼峰法命名,单词首字母全部大写
  • 成员变量名:m开头 + 驼峰法命名
  • 常量:全部字母大写,单词之间用下划线(_)连接
  • activity和fragment:模块包名 + activity/fragment + 功能名

xml文件

  • 布局文件:模块包名 _ activity/fragment _ 功能名
  • 布局文件中变量:字母全部小写,单词之间用下划线(_)连接,取名以功能和view相结合的方式
  • 布局文件中控件的大小需要写在资源文件里(dimens.xml),做好兼容性。
  • menu:模块包名 _ activity/fragment _ 功能名(和布局对应)
  • style:驼峰法命名,单词首字母全部大写
  • color:分为两部分(1):先以颜色色彩命名,驼峰法,首字母小写。
    (2)根据具体功能重新生成一个<color/>标签,根据对应的功能命名,并以color开头,驼峰法。

drawable

类型_功能

  • icon:ic _ 功能名
  • menu中使用的icon:ic_menu_功能名
  • 背景:bg_功能名
xml命名,更加对应的功能模块名快速查找
drawble命名

编码

  • 在自己负责的功能模块下开发,如有新功能模块,建立新的分包。
  • 在自己写的每个文件写好注释和作者。

文案

  • 写完代码后在README.md文件中写好文件名及对应的解释,作者。
    如:MainActivity -> 主页面 linlongxin,方便后期查找,有问题更容易找到作者。

其他

开发中大部分情况下是多人团队合作,每个成员的编码风格经过上面规则可以得到统一,但是对于逻辑的处理,架构的选择(如:mvp,mvc)也应该统一,在每次提交代码后,应该由技术团队技术当担来审核代码的规范性。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容

  • 参考资料:我总结的Android编程规范 1. 命名规则 1.1 类名,接口名: 以大写开头,如果一个类的类名由多...
    Coder_Y阅读 2,780评论 12 60
  • 前言 通过建立代码编写规范,形成Android编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证...
    yabin小站阅读 1,157评论 1 13
  • 命名规范 1. 基本原则 (1) 代码风格与android源码保持一致(2) 命名要清晰明了、有明确含义(3) ...
    Brian512阅读 557评论 0 5
  • 文章来自https://github.com/Blankj/AndroidStandardDevelop#安卓开发...
    小庄bb阅读 734评论 0 1
  • 做好你自己,坚强勇敢自信一些,所有的相遇都是有缘分的,所以拥抱生活中的一切,随着你的心走吧,是或是不是,也许很快就...
    慕容一一阅读 98评论 0 0