分享一个 Android XML 的命名规范

简评:当开始一个新项目的时候,我们通常都会去关心项目的架构、要用哪些技术等等。但对于资源文件的命名同样重要,良好的命名规范能让我们更快、更方便的找到目标文件,节省时间,就是节约金钱啊。

对于 Android 开发中资源文件的命名,很多人一直模棱两可,这里就给大家分享一个 Android 资源文件的命名规范。

基本规则

  • <WHAT>:指明文件实际是什么。比如,MainActivity -> activity_
  • <WHERE>:指明文件在应用中属于哪个模块。多个屏幕都会用到的资源使用 all_,其他的分别是所属的 Android 视图名。比如,MainActivity -> activity_main,ArticleDetailFragment -> fragment_articledetail。
  • <DESCRIPTION>:区分一个屏幕中的多个元素。比如,title
  • <SIZE>(可选):一个精确的大小或对大小的描述。用于 drawable 和 dimension。比如,_24dp, _small。

这样命名的优点:

  1. 资源文件按屏幕排序。<WHERE> 指明了资源文件所属的屏幕,所以你能很快找到某个特定界面的资源文件。
  • 更好的组织结构。Android Studio 中的文件是按照字母顺序的,因此 WHAT 和 WHERE 前缀就起到了文件分类的作用。
  • 更高效的自动完成。通常只需输入 WHAT 或 WHERE 就足以将自动完成提供的选项缩小到合适的程度。
  • 合乎逻辑的资源文件命名,会让你的 Android 项目结构更加清晰。

LAYOUT

布局文件的命名规则可以简化为:


<WHAT> 是下面的其中一个:



示例:

  • activity_main
  • fragment_articledetail
  • view_menu
  • item_article
  • layout_actionbar_backbutton

STRING

对于字符串来说同样不需要 <WHAT> 前缀,因此直接用 <WHERE> 作为前缀。



如果字符串会在多个页面被用到,使用 all_ 作为前缀。

示例:

  • articledetail_title
  • feedback_explanation
  • feedback_namehint
  • all_done

DRAWABLE

同样,对于 drawable <WHAT> 是没有必要的,因此我们这样来命名:


会被复用的 drawable 同样以 all_ 作为前缀:


注意 <SIZE> 是可选的。示例:

  • articledetail_placeholder
  • all_infoicon
  • all_infoicon_large
  • all_infoicon_24dp

ID

对于 ID,<WHAT> 是 xml 元素的类名,比如 tablayout, imageview 等等。<WHERE> 是 xml 文件所在屏幕的名称。


示例:

  • tablayout_main
  • imageview_menu_profile
  • textview_articledetail_title

DIMENSION

应当只定义有限的 dimension,并尽量复用它们。<WHAT> 前缀可以用下面列举的这些:



示例:

  • height_toolbar
  • keyline_listtext
  • textsize_medium
  • size_menu_icon
  • height_menu_profileimage

原文:A SUCCESSFUL XML NAMING CONVENTION

日报延伸阅读

欢迎关注

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

推荐阅读更多精彩内容