Android命名规范

Android开发代码规范相关系列文章:

  1. Android命名规范
  2. Android编码规范

俗话说:无规矩不成方圆,一个项目应该有统一的命名规范,开发者也应该有良好的编码规范,命名规范有以下几点要求:

  • 不能反人类。 曾经见过有个人对Activity这样的命名:
PersonActivityAddCustomer.java

就是以“模块名+Activity+页面名”的命名方式,简直就是奇葩,严重怀疑这个人的人生观、价值观和审美观。

  • 其次,要望文而知义,清晰准确,比如登陆页面的登陆按钮,命名就不能像Button1这样随心所欲,要类似于login_button(资源文件)或者btnLogin(java代码的按钮实例)这样的名称。
  • 此外,遇到MyTextView之类的命名,直接把创建该文件的同学拉出去打100大板,而且要肚皮朝上的那种打法

下面结合个人开发经验,说点具体规则

1. java类命名规范

  • Activity:以Activity作为后缀,比如PersonActivity
  • Adapter:以Adapter作为后缀,比如PersonAdapter
  • Entity:大多数以Entity作为后缀,比如PersonEntity,需要注意,在App开发时会一定一个全局变量User,这个不算做实体,不受此约束。

2. layout目录下的文件命名规范

  • 页面布局文件。以act_为前缀,以Activity所在Package作为中缀,以Activity的名称(去掉Activity后缀)作为后缀,注意都是小写。例如,对于Person模块下的AddCustomerActivity,它的layout文件应该是act_person_addcustomer.xml
  • ListView中的item布局文件。以item_作为固定前缀,列表项的名称为后缀。注意都是小写,例如,某个页面下面有一个用户列表,控件名称为lvUserList,那么item的laout就应该是:item_lv_userlist.xml
  • Dialog布局文件。以dlg_作为固定前缀,Dialog的功能名称作为后缀。注意都是小写,例如,dlg_hint.xml

3. drawable目录下的命名规范。
drawable目录下的资源,大部分都是图片,此外还有一部分xml文件,用于Selector。但无论图片,亦或是Selector文件,都应该遵守以下命名规范

  • 对于只在一个页面使用的资源,就以该页面的名称作为前缀
  • 对于只在一个模块下多个页面使用的资源,就以该模块的名称作为前缀
  • 对于在各个模块、各个页面都有可能是使用的资源,比如说上导航、下导航,就以common作为前缀

4. Java类控件对象的命名规范

控件类缩写+控件的逻辑名称(首字母大写),比如登录按钮,可以命名为btnLogin,下图列出了一些常用控件的缩写

常用控件缩写

5. Layout中控件的命名规范

  • 可以与Activity中相对应的控件名称保持一致,这样的好处是可以迅速copy-paste出以下代码而杜绝任何的潜在错误。
    但是这样做和传统的Android命名规范就不一致了,至少违反了2条原则,不应该有大写,btn和Login之间没有用下划线进行连接。
Button btnLogin = (Button)findViewById(R.id.btnLogin);
  • 建议写法:控件的功能名称+下划线+控件类名称,注意全部小写,例如登陆按钮,可以命名为login_button

其实两种写法都可以,但必须在项目中做到统一,不要混用,别反人类就行。

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

推荐阅读更多精彩内容

  • 无论是哪种编程语言的学习,我们的命名都要有一定的规范才能更好的进行团队协作,更好的进行代码的的二次开发。所以在这里...
    李庆文阅读 661评论 2 3
  • 前言 大家或许都有接手过别人的代码,最大的共同感悟就是:这代码写得真烂!!命令混乱、文件随意存放,xml文件中夹带...
    dean550阅读 538评论 0 3
  • 命名规范 1. 包命名 规则:包名全部小写,采用反域名命名规则,一级包名是顶级域名,通常为com, edu, go...
    聂顺阅读 844评论 0 2
  • 序:团队开发有一套自己的命名规范,方便大家review和code,今天我总结一下,后面有需要用到的,可以直接按这套...
    tomatozheng阅读 2,335评论 0 1
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,028评论 25 707