Android代码规范

命名规范

1.包命名

域名反写+项目名称+模块名称，全部单词用小写字母。
例如:com.jph.shopping

2.类和接口命名

使用大驼峰规则，用名词或名词词组命名，每个单词的首字母大写。
以下为几种常用类的命名：

• activity类，命名以 功能名+Activity，如：LoginActivity
• fragment类，命名以 功能名+Fragment，如：ShareDialogFragment
• service类，命名以Service为后缀，如：DownloadService
• adapter类，命名以Adapter为后缀，如：CouponListAdapter
• 工具类，命名以Util为后缀，如：EncryptUtil
• 数据模型类，直接以对应名词单词命名，如：Product
• 接口以I+具体功能命名，如：IPayOrder

3.方法命名

使用小驼峰规则，用动词命名，第一个单词的首字母小写，其他单词的首字母大写。如：initView, setData, isLogined…
方法名字必须表达方法的含义，如果表达不了就分拆方法。loadPostDetailsById(int id)
常用方法前缀：getXX(), isXXX(), initXXX(),setupXXX() loadXXX()

4.常量命名

全部为大写单词，单词之间用下划线分开。

• 常用常量

public final static int PAGE_SIZE = 20;

• Intent传参常量EXTRA_参数的意义,Intent Extra 的key全部写成常量

public static final String EXTRA_PRODUCT = "extra_product ";

5.变量命名

小驼峰规则，成员变量+m前缀（内部类也遵循该原则）

• 普通变量
  (m)+意义描述+类型描述，如：
  成员变量：

private Coupon mValidCoupon;

局部变量：

Product product;

• 控件变量
  (m)+意义描述+对应控件类型简写
  成员变量：

private TextView mTitleTxt;

局部变量：

EditText emailEdt;

6.控件id命名

所有xml相关全小写+_，模块类型/界面名+控件类型缩写+功能名

<Button    android:id="@+id/shopping_btn_login"    android:layout_width="match_parent"    android:layout_height="wrap_content"    android:text="@string/login"/>

控件 缩写 TextView txt Button btn ImageButton ibtn ImageView img ListView list RecyclerView recycler RadioGroup rgroup RadioButton rbtn ProgressBar progress LinearLayout layout RelativeLayout layout ScrollView scroll SeekBar seek CheckBox check

7. layout命名

{范围_}组件类型_功能，范围可选，也可加上子范围（例如:shopping_order_activity_coupon）只在有明确定义的范围内才需要加上。
以下为几种常用的组件类型命名：

• {范围_}activity_功能，为Activity的命名格式
• {范围_}fragment_功能，为Fragment的命名格式
• {范围_}dialog_功能，为Dialog的命名格式
• {范围_}item_list_功能，为List样式的item命名格式
• {范围_}item_grid_功能，为Grid样式的item命名格式
• {范围_}header_list_功能，为ListView等的HeaderView命名格式
• {范围_}footer_list_功能，为ListView等的FooterView命名格式
• {范围_}v_功能，自定义控件
• {范围_}layout_功能，自定义布局或者嵌套布局

8.strings的命名

{范围_}{控件_}功能，范围可选，控件可选。
以下为几种常用的命名：

• 公用string直接命名：address,name,password…
• 页面标题，命名格式为：shopping_title_页面
• 按钮文字，命名格式为：shopping_btn_按钮事件
• 文本文字，命名格式为：shopping_txt_标签文字
• 选项卡文字，命名格式为：shopping_tab_选项卡文字
• 消息框文字，命名格式为：shopping_toast_消息
• 编辑框的提示文字，命名格式为：shopping_hint_提示信息
• 图片的描述文字，命名格式为：shopping_desc_图片文字
• 对话框的文字，命名格式为：shopping_dialog_文字
• menu的item文字，命名格式为：shopping_action_文字

9. colors的命名

{范围_}{控件_}颜色名{_后缀}，控件、范围、后缀可选。后缀包含作用位置(bg、txt等)，状态等。

例如：shopping_btn_pay_bg_pressed

• 公用color直接命名：black,white,transparent,grey…
• 背景颜色，添加bg前缀
• 文本颜色，添加txt前缀
• 分割线颜色，添加divider前缀
• 区分状态时，默认状态的颜色，添加normal后缀
• 区分状态时，按下时的颜色，添加pressed后缀
• 区分状态时，选中时的颜色，添加selected后缀
• 区分状态时，不可用时的颜色，添加disable后缀

10.drawable的命名

{范围_}{控件_}drawable名{_后缀}，控件、范围、后缀可选，但控件和范围至少要有一个。

例如：shopping_check_product_ic_selected

• 图标类，后缀中添加ic
• 背景类，后缀中添加bg
• 分隔类，后缀中添加divider
• 区分状态时，默认状态，添加normal后缀
• 区分状态时，按下时的状态，添加pressed后缀
• 区分状态时，选中时的状态，添加selected后缀
• 区分状态时，不可用时的状态，添加disable后缀

注释规范

1. 文件头注释（暂时不用CopyRight）

文件顶部统一添加版权声明，声明的格式如下：

/*** Copyright (c) 2015. Keegan小钢 Inc. All rights reserved.*/

2. 类和接口注释

类和接口统一添加javadoc注释，格式如下：

/*** 类或接口的描述信息** Create By @author ${USER}* @date ${DATE}*/

3. 方法注释

下面几种方法，都必须添加javadoc注释，说明该方法的用途和参数说明，以及返回值的说明。

• 接口中定义的所有方法
• 抽象类中自定义的抽象方法
• 抽象父类的自定义公用方法
• 工具类的公用方法

/*** 登录** @param loginName 登录名* @param password  密码* @param listener  回调监听器*/public void login(String loginName, String password, ActionCallbackListener<Void> listener);

4. 变量和常量注释

下面几种情况下的常量和变量，都要添加注释说明，优先采用右侧//来注释，若注释说明太长则在上方添加注释。如果变量难懂，添加 /* /类型注释。

• 接口中定义的所有常量
• 公有类的公有常量
• 枚举类定义的所有枚举常量
• 实体类的所有属性变量

public static final int TYPE_CASH = 1; // 现金券public static final int TYPE_DEBIT = 2; // 抵扣券public static final int TYPE_DISCOUNT = 3; // 折扣券private int id;                // 券idprivate String name;           // 券名称private String introduce;      // 券简介