android 代码规范.doc

Android（java）编码规范 版本 日期 说明 V1.0 V1.1 2015.01.31 确定资源文件命名规范 命名规范 源代码命名 标识符 命名规则 示例 包 全部用小写字母，以ject开头，common为机构名，公共库则跟以库的功能英文缩写。建议各个项目以MVC模式区分包的功能。 ject.ui.*; ject.model.*; ject.controller.*; 类 名词，每个单词手写字母大写，类名要使用完整单词，避免使用缩写（除该词被广泛使用外，如URL，HTML）。 class ImageLoader; class GestureDetector; 接口 跟类名一致，以**able， **ible，**er为后缀。 interface Dragable; 方法 动词，第一个单词小写，从第二个单词起每个单词首字母大写。 void start(); void startLoad(); 常量 全部字符大写，以下划线形式连接单词 public static final int MAX_WIDTH = 100; 静态成员变量 以s开头，其他与局部变量一致 private static MyClass sSingleton; 非公有，非静态成员变量 首字符为m private int mPrivate; 公有变量 第一个单词小写，从第二个单词起每个单词首字符大写 public int publicField; 局部变量/参数 第一个单词小写，从第二单词起每个单词首字符大写 float myWidth; 资源文件命名 类别 命名规则 示例 layout(片段) 功能 功能_控件 browser_link_context_header select_dialog_multichoice Activity--对应layout ApiDemo Activity: 功能 Layout: 功能 NoteEditor--note_editor.xml XXXActivity--xxx.xml drawable ic_功能 ic_控件_功能 功能_状态 view（缩写）_功能_状态 建议view的缩写统一为: Linearlayout：ll Relativelayout：rl TextView：tv ImageView：iv ImageButton：ib Button：btn Animation：anim ic_input_add ic_dialog_alert presence_offline btn_star_big_on（/off） 多状态的drawable (无参考) view（缩写）_功能_selector btn_goods_selector.xml 自定义动画 （layout_）描述 slide_in layout_grid_inverse_fade 字符串资源 功能 组件_功能 Ps:建议所有的中文字符串都写在xml中，以免出现乱码 cancel search_go personal_title layout中的id-- activity中view命名 view缩写_功能 btn_start_search--mBtnStartSearch 或者mStartSearchBtn 或者mStartSearchButton color 通用颜色 功能或应用场景 为通用性和版本迭代考虑，不要在具体的功能或者场景前面加bg_，以及后面加上具体颜色描述，颜色很可能会改变的 lightyellow order_unchoose_tv_name bg_column_source_textcolor_gray Ps：所有的资源命名不要使用美元符号等特殊字符 源文件组织 采用以下顺序组织文件: 文件头注释 包、import 语句 类和接口的声明 文件头注释 所有的文件需要有一个C风格的注释包括 类名,版本信息, 时间, 版权声明等. 示例: /* * @(#)Blah.java 1.82 99/03/18 * * Copyright (c) 1994-1999 Sun Microsystems, Inc. * ... */ 包、import 语句 文件头注释后边空一行, 首先是包声明, 随后空一行是import语句, import语句的顺序按以下顺序（与android.importorder中对应）: Android imports 第三方库（com、junit、net、org） java和javax Android提供了android.importorder文件,可以