Android编码规范

一、开发环境

• 使用最新AndroidStudio版本开发(暂为2.3.3)
• sdk版本
  minSdkVersion=15;
  compileSdkVersion = 27
  targetSdkVersion =27
  buildToolsVersion = 27.0.2

二、命名规范

• 遵循驼峰命名规则，名字能准确描述表达的含义。能用简单英文单词表述的，尽量都统一用英文。
• 特殊情况对于传统业务叫法的可以用拼音如：GaoKao ，KaoYan。（这一原则尽量少用，如果要用需要统一）。

1. 变量命名

以google变量命名为规范，以小写m为前缀+变量英文含义。如：int mTitleColor;//标题颜色

2. 常量命名

使用全大写字母加下划线的方式命名。如： static final int MAX_RUNNING_USERS = 3

3. 控件命名

以小m为前缀+控件名称缩写+英文含义。如：Button mBtnStart;//开始按钮

4. Activity命名

规范：功能+Activity 如LoginActivity //登录界面

5. 接口

首字母大写，驼峰命名，使用名词。带I前缀，或able,ible,er等后缀，如IManager,OnClickListener。

6. 抽象类

首字母大写，驼峰命名，使用名词。使用Abs作为前缀。

7. 包

所有单词小写，只能包含a-z字母，或有含义的阿拉伯数字如4代替for,2代替to

8. 资源文件

    (1) 布局文件

    PopupWindow   popup_
    Menu          menu_
    Fragment      fragment_
    Dialog        dialog_
    Adapter       layoutitem
    Activity      activity_

    (2) 图片

    bg_xxx     背景图片
    btn_xxx    按钮
    ic_xxx     单个图标
    bg         描述 状态    控件上的不同状态
    btn        描述 状态    按钮上的不同状态
    chx        描述 状态    选择框，一般2态或4态

三、通用规则

• 不要直接跨业务模块调用方法，一个模块提供一个对外类
• 禁止将整个类格式化
• 每个类长度不超过1000行
• 一行最多只能写一条语句，不允许一行定义多个变量或执行多条语句
• 一个方法只做一件事情，方法体不能太长，且不能传入太多参数，一般5个以内，暂定不超过8个
• 每行代码不超过100个字符，超过的需要使用缩进换行
• 嵌套层数不应超过3层
• 代码中禁止使用硬编码，把一些数字或字符串定义成常量
• 用4个空格替代TAB符
• 恰当使用TODO:和FIXME

四、注释

1.类注释

/** 
 * Author: luffy
 * Date: 2018/3/27 15:40
 * Description: user login 
 */

模版(文件头部)
/**
 * Author: ${USER}
 * Date: ${DATE} ${HOUR}:${MINUTE}
 * Description: 
 */

2.方法注释

/**
 * service生命周期
 * @param intent
 * @param flags
 * @param startId
 * @return
 */