Android 代码规范

Android 代码规范

标签： Android代码规范

---

团队协作项目，为了保持大家的代码一致性，进行一些代码格式的规范

一.开发环境

1.统一使用UTF-8编码，避免乱码问题
Android Studio设置:

Settings->Editor->File Encodings

IDE Encoding : 选择UTF-8

Project Encoding : 选择UTF-8

Default encoding for properties files : 选择UTF-8

2.开发IDE使用Android Studio或者Intellij IDEA

3.注释模板

Author:开发人员
Date:时间
Description:描述信息，说明此类的作用

/** 
 * Author: ${USER} 
 * Date: ${DATE} ${TIME}  
 * Description:
 */

Android Studio设置:

Settings->Editor->File and Code Templates->Includes->File Header->复制头模板到文本框中

例如：

package com.test.main;

/**
 * Author: river
 * Date: 2015/9/16 17:00
 * Name: com.test.main
 * Description: 这是测试样例
 */
public class Test {
    /**
     * 总共10个
     */
    public final static int COUNT = 10;

    /**
     * 打印数量
     * @param count 数量
     */
    public void print(int count){
       //...
    }
}

二.命名规范

1.包命规范

采用反域名命名规则，包名全部小写
一级包名为com
二级包名为xxx（公司域名或者个人命名）
三级包名根据应用进行命名
四级包名为模块名或层级名

例如：
com.google.app.test

2.类名规范

采用大驼峰式命名法，尽量避免缩写(module_name:功能或者模块功能名称)
继承系统接口命名规则:
Activity : {module_name}+Activity
Fragment : {module_name}+Fragment
Adapter : {module_name}+Adapter
BroadcastReceiver : {module_name}+Receiver
…

例如:
LoginActivity

3.变量命名(仅供参考，自行选择)

使用标准的Java命名方法
private String userName;

使用Google的m命名法
private String mUserName;

4.组件View ID命名(二选一，不可混用,仅供参考，可以自行网上查找资料)
例如:
在布局中 Button 的id为: android:id="@+id/btn_login"
在代码中Button的命名:private Button btn_login;

或者
在布局中 Button 的id为: android:id="@+id/btn_login"
在代码中Button的命名:private Button mBtnLogin；

View xml中id规则：组件首字母的缩写或者取组件首字母(如：TextView:tv)
常见控件View与其缩写对照参考表如下

例如：
Button:btn
TextView:tv

5.布局文件(Layout)命名规范

module_name:模块名称
function_name：功能名称
格式：{module_name}{function_name}相应布局类型
全部小写，采用下划线命名法

activity layout： {module_name}_{function_name}_activity
例如：login_activity_main.xml

fragment layout:{module_name}_{function_name}_fragment
例如：login_fragment_main.xml

Dialog layout: {module_name}_{function_name}_dialog
例如：login_dialog_loading.xml

列表项布局命名：{module_name}_{function_name}_list_item
例如：login_list_item_customer.xml

包含项布局命名：include_{功能名称}
例如：include_head.xml

7.图片资源文件命名规范

格式 : ic_{功能名称}

图标命名：ic_{功能名称}
例如：ic_login.png

背景图片命名： bg_{功能名称}
例如：bg_login_normal.9.png

按钮Button命名： btn_{功能名称}
例如：btn_login_normal.9.png

参考：新浪微博Android SDK 代码规范