盒子
盒子
文章目录
  1. 包的命名
  2. 类中代码的顺序
    1. 变量
    2. 方法
  3. 类的命名
    1. Activity
    2. Fragment
    3. Adapter
    4. Helper类
    5. 工具类
    6. 回调接口
    7. 监听接口
  4. 变量的命名
  5. 方法的命名
  6. 资源文件命名
    1. 布局
    2. 图片
    3. 代码图形
  7. 基本原则

Android编程规范

如果不是初学者,代码规范性的重要程度不言而喻,结合自身的经验以及网络上其他的建议,总结如下Android代码规范。

包的命名

下面是我平时开发的部分命名方式

1
2
3
4
5
6
7
8
9
10
11
12
-src
---|app ---> 包含Application以及全局性的类
---|constants ---> 常量类
---|helper ---> APP内部的帮助类
---|utils ---> APP内部的工具类
---|callback --->通用的回调接口
---|interfaces --->通用的监听接口
---|ui --->UI相关
------|activity --->Activity
------|fragment --->Fragment
------|adapter --->Adapter
------|widget --->自定义控件

类中代码的顺序

变量

1.常量

2.静态变量

3.成员变量

根据功能作用可中间加空行分隔

方法

1.构造函数

2.生命周期函数

3.Override函数

4.public函数

5.protected函数

6.private函数

类的命名

首字母大写,后面驼峰,使用名词

Activity

XxxActivity.java

Fragment

XxxFragment.java

Adapter

XxxAdapter.java

Helper类

XxxHelper.java

工具类

XxxUtils.java

回调接口

XxxCallback.java

监听接口

XxxListener.java

变量的命名

1.常量: 所有单词大写,单词以_分隔

2.静态变量:s开头,后面驼峰

3.成员变量: m开头,后面驼峰

方法的命名

首字母小写,后面驼峰

资源文件命名

布局

Type Layout
Activity activity_xxx
Fragment fragment_xxx
Adapter item_xxx
Dialog dialog_xxx
PopupWindow popup_xxx
Menu menu_xxx
Dialog dialog_xxx
布局引用 include_xxx
通用视图 view_xxx

图片

Type Name
背景图片 bg_xxx
按钮图片 btn_xxx
单个图标 icon_xxx

代码图形

Type Name
Selector selector_xxx
Shape shape_xxx

以此类推

基本原则

  • 删除默认的TODO,合理使用TODOFIXME
  • 标识性的数字一定要定义成常量
  • 代码与符号之间加空格
  • 函数参数不可过多,最好不超过4个
  • 一般的Exception抛出交给调用者处理
  • 代码注释认真写

暂时这么多,后面有的话再补充

转载请指明出处RobinBlog:http://robinx.net/2016/12/02/Android编程规范/