包命名规范
包(packages):采取反域名命名规则,全部使用小写字母。1级包名为com,2级包名为xxx(可以是公司域名或个人命名),3级包名根据利用进行命名,4级包名为模块名或层级名。
包名 | 说明 |
com.xxx.利用名称缩写.activities | 页面用到的Activity类(activities层级用户界面) |
com.xxx.利用名称缩写.fragment | 页面用到的Fragment类 |
com.xxx.利用名称缩写.base | 页面中每一个Activity类同享的可以写成1个BaseActivity类(基础同享的类) |
com.xxx.利用名称缩写.adapter | 页面用到的Adapter类(适配器的类) |
com.xxx.利用名称缩写.utils | 此包中包括:公共工具方法类(包括日期、网络、存储、日志等工具类) |
com.xxx.利用名称缩写.bean (model/domain都可,个人喜好) | 实体类 |
com.xxx.利用名称缩写.db | 数据库操作 |
com.xxx.利用名称缩写.view(或.ui) | 自定义的View类等 |
com.xxx.利用名称缩写.service | Service服务 |
com.xxx.利用名称缩写.broadcast | Broadcast服务 |
类命名规范
类(classes):名词,采取大驼峰命名法,尽可能避免缩写,除非该缩写是尽人皆知的,比如HTML,URL,如果类名称包括单词缩写,则单词缩写的每一个字母均应大写。
类 | 描写 | 例如 |
Application类 | Application为后缀标识 | XXXApplication |
Activity类 | Activity为后缀标识 | 闪屏页面类 SplashActivity |
解析类 | Handler为后缀标识 | |
公共方法类 | Utils或Manager为后缀标识 | 线程池管理类:ThreadPoolManager 日志工具类:LogUtils |
数据库类 | 以DBHelper后缀标识 | MySQLiteDBHelper |
Service类 | 以Service为后缀标识 | 播放服务:PlayService |
BroadcastReceiver类 | 以Broadcast为后缀标识 | 时间通知: TimeBroadcast |
ContentProvider类 | 以Provider为后缀标识 | 单词内容提供者:DictProvider |
直接写的同享基础类 | 以Base为前缀 | BaseActivity, BaseFragment |
变量命名规范
变量(variables)采取小驼峰命名法。类中控件名称必须与xml布局id保持1致。
公然的常量:定义为静态final,名称全部大写。eg: public staticfinal String ACTION_MAIN=”android.intent.action.MAIN”;
静态变量:名称以s开头 eg:private static long sInstanceCount = 0;
非静态的私有变量、protected的变量:以m开头,eg:private Intent mItent;
接口命名规范
接口(interface):命名规则与类1样采取大驼峰命名法,多以able或ible结尾,eg:interface Runable; interface Accessible;
方法命名规范
方法(methods):动词或动名词,采取小驼峰命名法,eg:onCreate(),run();
方法 | 说明 |
initXX() | 初始化相干方法,使用
生活不易,码农辛苦 |