【Android】【基础篇】编码规范

写在前面:

不论是哪种语言,规范的编码总能准确描述表达的含义,让人较容易明白,好的代码规范能够省去很多注释,提高同事之间的工作效率。

下面就总结一下我平时用到的代码规范。


先介绍两种命名规则:

驼峰命名法:又称小驼峰命名法。除了首个单词首字母小写除外,其余所有单词所有首字母都要大写。

帕斯卡命名法:又称大驼峰命名法。所有单词首字母大写。


1、包的命名规范

所有单词小写,只能包含a-z字母,或有含义的阿拉伯数字如4代替for,2代替to

建议采用如下规则:【com】.【公司名/组织名】.【项目名称】.【模块名】

常见的包分层结构如下:

com.xxx.xxx.view –> 自定义view 或者是View接口

com.xxx.xxx.activities –> activity类

com.xxx.xxx.fragments –> fragment类

com.xxx.xxx.adapter –> 适配器相关

com.xxx.xxx.utils –> 公共工具类

com.xxx.xxx.bean –> 实体类

com.xxx.xxx.service –> service服务

com.xxx.xxx.broadcast –> 广播接收器

com.xxx.xxx.db –>数据库操作类

com.xxx.xxx.persenter –> 中间对象

com.xxx.xxx.model –> 数据处理类


2、类的命名规范

首字母大写,大驼峰命名法,使用名词。

Activity                        类Activity为后缀标识                

Adapter类                    Adapter 为后缀标识              

解析类                         Parser为后缀标识                   

工具方法类                  Util或Manager为后缀标识      

管理类                         Manager为后缀标识                 

Service类                    以Service为后缀标识 

Receiver类                  以Receiver为后缀标识

ContentProvider          以Provider为后缀标识

自定义基类                  以Base开头

自定义view                  功能描述 + View

自定义widget               模块名 + 类型(List/Info) + Widget


3、常量命名

所有单词大写,单词间以”_“分隔


4、变量命名

驼峰命名。成员变量以m开头;静态变量以s开头


5、方法命名

与java开发类似,采用驼峰命名规则。首单词首字母小写,其余单词首字母大写。尽量不要使用下划线。

6、资源文件

1)布局文件

Activity-------------------activity_

Fragment-------------------fragment_

Dialog-------------------dialog_

PopupWindow-------------------popup_

Menu-------------------menu_

Adapter-------------------layout_item_

(2)图片

bg_xxx-------------------背景图片

btn_xx-------------------按钮

ic_xxx-------------------单个图标

bg _ 描述 _ 状态-------------------控件上的不同状态

btn _ 描述 _ 状态-------------------按钮上的不同状态

chx _ 描述 _ 状态-------------------选择框,一般2态或4态

(3)anim目录下的命名规范

单词全部小写,单词之间采用下划线分割。

fade_in.xml

fade_out.xml

slide_in_from_left.xml

slide_in_from_top.xml

slide_out_to_right.xml

slide_out_to_bottom.xml



目前收集到的结合平时自己的使用习惯大概就这些,好的命名规范是一项重要的技能,可以在团队合作中可以很大限度减少沟通成本。无规范不成方圆。

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

推荐阅读更多精彩内容

  • 文章来自https://github.com/Blankj/AndroidStandardDevelop#安卓开发...
    小庄bb阅读 756评论 0 1
  • Android编码规范 源文件基础 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。 文...
    呼呼哥阅读 943评论 0 0
  • Java类类名:大驼峰命名,所有单词首写字母大写,并且类名最好为名词.正确public class People{...
    WilsonMing阅读 775评论 0 2
  • 作者:李旺成 时间:2016年4月3日 1. 前言 这份文档参考了 Google Java 编程风格规范和 Goo...
    diygreen阅读 39,911评论 19 224
  • written by leo.wang Android代码开发规范 1 类声明 1.1 只有一个顶级 类声明每个顶...
    Poseidon_Wang阅读 651评论 0 0