Android代码规范(自用)

命名规范和排版

java成员类

1. 基础类型优先排在上方

2. java相关类排在基础类型下方

3. android相关类排在java相关类下方

4. 整体排序按照访问权限:private->default->protected->public 由低到高排序

5. 以上的模块间以一个空行隔开

6. 所有成员类命名均以小写m开头,采用驼峰命名

7. 静态成员变量放在以上模块最上方

8. 封装的bean类成员变量不需要以小写字母m开头,采用驼峰命名即可

示例图片

示例图片

类方法

1. android中方法排序首先生命周期方法在最上方,排序按照自然生命周期的排序

2. 其余方法按照调用先后顺序往下排列

3. 方法体内不要多余无意义的空行,代码紧凑

示例

文件和目录命名规范

1. 工程目录下所有文件夹名一律用小写字母
2. drawable目录所有图片资源一律以 ic_ 为前缀开头
3. 同一资源图片不同尺寸一律相同命名以尺寸大小为后缀,如 ic_default_600_400 , ic_default_300_200
4. adapter类的填充展示布局一律以 item_ 为前缀
5. listview 和recycleview等类似头部和尾部布局概念分别以 head_ , foot_ 为前缀
6. shape 文件 和 selector 文件 分别以 shape_ , selector_ 为前缀

色值命名

以色值本身的名字来命名,而不是以功能性的名称表达如 btn_bg, tv_bg 这样很容易有些色值重复.

示例

常用缩写和模型的统一命名

这个需要团队成员讨论修改和补充,基本原则:对同一概念采用相同的名词表达,减少同一模型的重复封装.

​

缩写	驼峰	描述
id	Id
url	Url
brandId	BrandId	汽车的品牌id

其他

1.引用第三方库时,第一时间在混淆文件中加上相应配置,并加上少量描述.不得最后添加混淆配置,节约调试时间.

示例.png

2.创建的java文件上方最少注明作者和创建时间等简要信息,这个可以通过设置androidstudio模板减少工作量.

QQ图片20170219214843.png