android 命名规范和编码规范

Posted 西北野狼

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了android 命名规范和编码规范相关的知识,希望对你有一定的参考价值。

书里面讲的比较常见,单个人也是有不同的观点;

因为android绝大部分使用java开发的,因此java相关规范适用于android:

Google Style:

英文地址:http://google-styleguide.googlecode.com/svn/trunk/javaguide.html

中文翻译:http://www.blogjava.net/zh-weir/archive/2014/02/08/409608.html

然后说下我在android开发中的命名规范和编码规范:

先分享一个我经常参考的规范:

http://blog.csdn.net/vipzjyno1/article/details/23542617

http://blog.csdn.net/wwj_748/article/details/42347283

内容基本类似

activity命名规范:页面名称+Activity;

adapter命名规范:页面名称+Adapter;

Entity命名规范:书里面是模块或者页面名称+Entity,但是我个人习惯是接口名称后缀+Result(这个如果看管有意见,可以在评论区里面进行探讨)。

资源文件命名:

页面布局文件:和书里面不一样,我是以activity或者frament文件命名语句倒叙来命名,比如LoginActivity,laout文件会命名为activity_login.xml;

ListView的item文件以item来开头,以列表名称结尾,和书里面保持一致。

drawable文件命名规范:按下背景切换的用selector结尾;

书里面比较优秀的观点:

只有一个页面使用的文件,以页面名称作为前缀;

如果一个文件一个模块多个文件使用,以模块作为前缀;

如果多个模块使用,则以common来最为前缀。

常用控件缩写:

同如下网页里面分享的

http://blog.csdn.net/vipzjyno1/article/details/23542617

关于layout中的id命名和初始化视图控件变量的时候的命名,我和书里面保持一致,都是和layout里面的命名保持一致,有利于拷贝,粘贴。

关于颜色命名,我认为以颜色名称命名不怎么好,我的方式是color_dc181c = "#dc181c"这种形式。

关于尺寸的命名也是一样,我的命名是dimen_45dp = "45dp"这种。

 

android里面代码风格的统一,除了如果的规范外,可以通过模板模式,在基类对规范的风格进行统一,通过抽象方法来控制,比如initView()和initDate(),组件单击事件这种抽象的方法封装在基类里面,每个队员写代码的时候,必须继承自你的基础代码,然后在统一的代码块里面进行编写。

layout文件里面不要常量数据封装到string.xml文件里面去,不建议在布局文件里面处理。

布局预览可以通过tool来进行控制:

<Button
    android:id="@+id/button2"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="Second"
    tools:visibility="visible" />

类似也有tools:text = "android"这种方式。

 

Adapter绑定数据一律arrayList,这点表示同意。

网络操作或者图片缓存建议使用成熟的库进行处理,而不是自造轮子处理。

进来使用application的context,而不是使用activity的context,因为容易内存泄露的。

使用常量代替枚举。

最后推荐两个规范和方式bug的工具,androidstudio的format统一code的风格checkstyle,findbugs。

以上是关于android 命名规范和编码规范的主要内容,如果未能解决你的问题,请参考以下文章

Android 命名规范以及编码规范

android 命名规范和编码规范

浅谈Android编码规范及命名规范

Android 编码规范及代码风格

Android 编码规范

Android 编码规范