Carson带你学Android:你不能忽略的代码命名规范

前言

  • Android代码规范内容非常多,但对我们最有用& 最有影响的莫过于 Android代码的命名规范
  • 可是,有很多人容易忽略Android代码的命名规范,从而导致代码的可读性 & 维护性非常差,最终导致开发效率 & 维护效率降低
  • 今天,我将根据 Google Java 编程规范 & Google 官方 Android 编码规范,为大家带来一份全面 & 清晰的Android代码命名规范,希望你们会喜欢。

目录

示意图

1. 为什么 规范 Android 代码命名?

  • 增强代码的可读性
  • 增强代码的可维护性

正由于上述两个作用,从而使得 开发效率 & 维护效率 得到大幅度的提高。


2. Android需要命名的代码(对象)有哪些?

示意图

3. 具体命名规范

下面,我将对 Android 代码对象中的命名规范进行详细讲解

注:由于 Android主要用Java实现,所以Android规范会涵盖部分Java规范

3.1 包

  • 基础规则:小写、单词间连续无间隔、反域名法(分为4级,具体如下图)
示意图
  • 第4级包名会随着功能的不同而不同。下面我列举出一些常见 & 需要规范的4级功能包名
示意图

3.2 类

  • 基础规则
    1. 类型 = 名词 / 名词短语;
    2. 形式 = 驼峰形式中的 大骆驼拼写法UpperCamelCase

即名称中的每个词的首字母都大写,如 AndroidStudio

  • 在具体命名类时,会根据 该类的类型不同而附加额外的命名规则。具体如下图
示意图

3.3 变量

  • 基础规则
    1. 类型 = 名词 / 名词短语;
    2. 形式 = 驼峰形式中的 小骆驼拼写法LowerCamelCase

即名称中的第1个词的首字母小写,后面每个词的首字母大写,如androidStudioTool

  • 在具体命名变量时,会根据该变量的类型不同而 附加额外的命名规则。具体如下图
示意图

3.4 方法

  • 基础规则
    1. 类型 = 动词 / 动词短语;
    2. 形式 = 驼峰形式中的 小骆驼拼写法LowerCamelCase

即名称中的第1个词的首字母小写,后面每个词的首字母大写,如androidStudioTool

  • 在具体命名 方法名时,会根据 该方法名的作用不同而 附加额外的命名规则。具体如下图
示意图

3.5 参数名

  • 基础规则:驼峰形式中的 小骆驼拼写法LowerCamelCase

即名称中的第1个词的首字母小写,后面每个词的首字母大写,如androidStudioTool

  • 附加命名规则:功能名,如userName

3.6 资源

  • Android的资源包括:
示意图
示意图

下面,我将对每种Android资源的命名规则进行详细讲解

3.6.1 布局文件资源

示意图

3.6.2 图片资源

示意图

3.6.3 参数值资源

示意图

3.6.4 动画资源

示意图

3.7 额外

除了上述的命名规范以外,Android 中还有一些全局通用的命名规范:

示意图

至此,关于Android的代码命名规范讲解完毕


4. 附录:常见使用单词缩写表

  • 使用单词缩写的原则:只使用约定俗成的单词缩写

严禁自由缩写单词

  • 具体如下图
示意图

5. 总结

  • 看完本文后,相信你以后会认真对待 Android代码命名了!

  • 下一篇文章我将对讲解Android 的相关知识,感兴趣的同学可以继续关注本人的简书哦。

相关系列文章阅读
Carson带你学Android:学习方法
Carson带你学Android:四大组件
Carson带你学Android:自定义View
Carson带你学Android:异步-多线程
Carson带你学Android:性能优化
Carson带你学Android:动画


欢迎关注Carson_Ho的简书

不定期分享关于安卓开发的干货,追求短、平、快,但却不缺深度


请点赞!因为你的鼓励是我写作的最大动力!

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

推荐阅读更多精彩内容

  • 食用注意(現在才寫_(:3」∠)) 原著世界描述不多,現代架空ooc,狗血劇情多,原著中跟鳴人的最後一戰有。完全沒...
    莫鴆阅读 4,428评论 2 6
  • 人生有一万种可能,你只终于一种嘛? 迟山闲听雨急落点花红疑似蓬莱客御云送晚晴 清池雨点豆细露娇芙蓉一叶缠曲茎信手剥莲蓬
    青梅3煮酒阅读 286评论 1 1
  • 除去今天,再过两天就是新的一年-2017年。这一年的事情竟然好多都想不起来了。是我不愿意记忆吧,不管是高兴的不高兴...
    望飞雪阅读 209评论 2 1
  • 摘要: Zookeeper集群安装 SpringMVC+Mybatis, Dubbo+Zookeeper, jav...
    ITsupuerlady阅读 161评论 0 0
  • 2016最后一天跟2016的前三百六十四天好像也没有什么不同,但难能可贵的是201...
    朱想不通阅读 388评论 6 6