| — | — | — |
| Activity
类 | 模块名 + Activity
| 闪屏页类 SplashActivity
|
| Fragment
类 | 模块名 + Fragment
| 主页类 HomeFragment
|
| Service
类 | 模块名 + Service
| 时间服务 TimeService
|
| BroadcastReceiver
类 | 功能名 + Receiver
| 推送接收 JPushReceiver
|
| ContentProvider
类 | 功能名 + Provider
| ShareProvider
|
| 自定义 View | 功能名 + View/ViewGroup(组件名称) | ShapeButton
|
| Dialog对话框 | 功能名+Dialog | ImagePickerDialog
|
| Adapter
类 | 模块名 + Adapter
| 课程详情适配器 LessonDetailAdapter
|
| 解析类 | 功能名 + Parser
| 首页解析类 HomePosterParser
|
| 工具方法类 | 功能名 + Utils
或 Manager
| 线程池管理类:ThreadPoolManager
|
日志工具类:LogUtils
(Logger
也可)
打印工具类:PrinterUtils
|
| 数据库类 | 功能名 + DBHelper
| 新闻数据库:NewsDBHelper
|
| 自定义的共享基础类 | Base
+ 基础 | BaseActivity
, BaseFragment
|
| 抽象类 | Base
/ Abstract
开头 | AbstractLogin
|
| 异常类 | Exception
结尾 | LoginException
|
| 接口 | able
/ ible
结尾 / I 开头 | Runnable
, Accessible
,ILoginView
|
测试类的命名以它要测试的类的名称开始,以 Test 结束。例如:HashTest
或 HashIntegrationTest
。
接口(interface):命名规则与类一样采用大驼峰命名法,多以 able 或 ible 结尾,如 interface Runnable
、interface Accessible
。
注意:如果项目采用 MVP,所有 Model、View、Presenter 的接口都以 I 为前缀,不加后缀,其他的接口采用上述命名规则。
方法名都以 lowerCamelCase
风格编写。
方法名通常是动词或动词短语。
| 方法 | 说明 |
| — | — |
| initXX()
| 初始化相关方法,使用 init 为前缀标识,如初始化布局 initView()
|
| isXX()
, checkXX()
| 方法返回值为 boolean 型的请使用 is/check 为前缀标识 |
| getXX()
| 返回某个值的方法,使用 get 为前缀标识 |
| setXX()
| 设置某个属性值 |
| handleXX()
, processXX()
| 对数据进行处理的方法 |
| displayXX()
, showXX()
| 弹出提示框和提示信息,使用 display/show 为前缀标识 |
| updateXX()
| 更新数据 |
| saveXX()
, insertXX()
| 保存或插入数据 |
| resetXX()
| 重置数据 |
| clearXX()
| 清除数据 |
| removeXX()
, deleteXX()
| 移除数据或者视图等,如 removeView()
|
| drawXX()
| 绘制数据或效果相关的,使用 draw 前缀标识 |
这里的变量为广义的变量,包括了常量、局部变量、全局变量等,它们的基础规则是:
-
类型需要是名词 / 名词短语;
-
采用
lowerCamelCase
风格;
在具体的变量命名时,会根据该变量的类型不同而附加额外的命名规则:
| 类型 | 说明 | 例如 |
| — | — | — |
| 常量 | 大写 & 下划线隔开,Kotlin 一定要 const val | const val TYPE_NORMAL = 1
|
| static final TYPE_NORMAL = 1
| | |
| 临时变量名 | 整型:i
、j
、k
、m
、n
,字符型一般用 c
、d
、e
| for(int i = 0;i < len; i++)
|
| 其他变量 | lowerCamelCase
风格即可,私有变量也不要使用 m
开头 | private int tmp;
|
| Kotlin | 只读变量使用 val
,可变变量使用 var
,尽可能使用 val
| var tmp = 0
|
| val defaultIndex = 0
| | |
Android 的资源包括:
资源文件命名为全部小写,采用下划线命名法。
3.5.1 动画资源文件(anim/ 和 animator/)
安卓主要包含属性动画和视图动画,其视图动画包括补间动画和逐帧动画。属性动画文件需要放在 res/animator/
目录下,视图动画文件需放在 res/anim/
目录下。命名规则:{模块名_}逻辑名称
。
说明:
{}
中的内容为可选,逻辑名称
可由多个单词加下划线组成。例如:refresh_progress.xml
、market_cart_add.xml
、market_cart_remove.xml
。
如果是普通的补间动画或者属性动画,可采用:动画类型_方向