安卓命名规范

基本原则

定义规范的目的是为了使项目的文件、代码有规律可循，使程序有良好的可读性，从而方便项目的维护和扩展。

原则上只要把同一模块的代码文件聚到一起，把各个模块区分开来即可，以下都是一些约定俗成的命名方式或者一些参考建议。

 

包的命名（全部小写，由域名定义）

1，项目的基础包名：

域名倒写+项目名称，

比如公司的域名为gzpykj.com,广宏养老项目名称ghnhms

合起来是 com.gzpykj.ghnhms

 

2，基础包下的包名：

按需求来确定，一般有：

base包，里面是整个项目通用的类，比如基础的activitiy，header

data包，里面是和后台数据或者本地数据对接的类

config包，里面是一些app全局的配置信息类

utils包，里面是一些工具类

module包，里面包含项目的各个模块，为开发项目主要操作的包，如果模块比较少的话也可以去掉直接在外面以模块来新建包

 

3，模块包的命名：

模块包名按模块名称或名称缩写来命名，包名尽量不要超过6个字母，比如登陆注册模块可以命名为login，工作单模块可以命名为work，各个模块之间互不影响，如果模块包下的类比较多，则还可以继续分，比如按功能类型分类，act(activity)，adp(adapter)，view，fgm(fragment)

 

类的命名（英文命名，单词首字母大写）

1，普通类的命名

根据约定，Java类名通常以大写字母开头，如果类名称由多个单词组成，则每个单词的首字母均应为大写例如TestPage；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample,还有一点命名技巧就是由于类是设计用来 代表对象的，所以在命名类时应尽量选择名词。 　　 
例如： Graphics

 

2，模块包下类的命名

类名尽量以模块包名开头，结尾最好是类的功能类型的简写，中间则是描述，

如在工作单模块创建的包为work，下面有列表页、详情页、报工页、评价页，可以命名为WorkListAct、WorkDetailAct、WorkSubmitAct、WorkEvaluateAct,这样在代码中打Work的时候，只提示工作单模块下的类，方便查找

常用可以简写的类有

Activity----------Act

Adpater---------Adp

Fragment-------Fgm

 

方法的命名

采用小驼峰命名法 例如:onCreate(),initView()；

 

下面是一些约定俗成的方法：

initXXX()    初始化相关方法,使用init为前缀标识

isXXX()      checkXXX() 方法返回值为boolean型的请使用is或check为前缀标识

getXXX()     返回某个值的方法，使用get为前缀标识

processXXX() 对数据进行处理的方法，尽量使用process为前缀标识

showXXX() 弹出提示框和提示信息，使用display为前缀标识

saveXXX()    与保存数据相关的，使用sav为e前缀标识

resetXXX()   对数据重组的，使用reset前缀标识

clearXXX()removeXXX()  清除数据相关的，使用clear或remove为前缀标识

drawXXX()     绘制数据或效果相关的，使用draw前缀标识

 

字段的命名

1，整体采用类的前缀+名称，小驼峰命名法

下面是一些约定俗成的前缀：

byte    byte

Int     int

string   str

[]     arr

List    lst

StringBuffer  sb

Map    map

Object   ob

2，View的字段命名：

① 与View的id名称一样，方便copy，注解时只要在上面加@ViewInject即可

如view的id是:

R.id.user_name, 那么字段名称就是user_name,

R.id.userName, 那么字段名称就是userName

 

② 和整体规则一样, R.id.user_name为tvUserName。

 

注释

1，公共类的注释

在公共类加上注释可以快速地帮你了解其功能和作用，一般采用文档注释,

属性自由定义，一般有下面3种属性，可以编辑器里设置生成快捷键

/**

* 创 建 人：

* 日    期：

* 描   述：

* ......

*/

2，方法的注释

一般都是采用文档注释,

/**  

* 功能描述：

* 参数：

* ......

*/

 

 

3，字段的注释

静态成员变量采用文档注释，

变量采用单行注释。

 

 

资源文件的命名

1，Layout文件的命名

安卓下的layout只有一个文件夹，又不能在里面新建文件夹进行分类，所以文件会比较多，请务必遵循基本原则；

以模块包名为前缀(如果是全局通用的view文件，以bs开头)，下划线来区分,后面加控件类型的缩写，再加功能描叙

比如main模块下的资源文件

Activity的布局文件，                main_act_xxx

Activity的布局的子布局文件(include)   main_item_xxx

Fragment的布局文件                mian_fgn_xxx

Dialog的布局文件                   mian_dlg_xxx

View下的子布局文件，比如：

ListView的项布局文件           mian_lv_item_xxx

GridView的项布局文件          mian_gv_item_xxx

 

 

 

2，样式文件的命名

Style文件，style加控件类型

TextView样式:      style_tv

EditText样式:       style_ed

CheckBox样式:      style_cb

RadioButton样式:   style_rb

ProgressBar样式:    style_pg

...

 

Style里面的名称命名：

以控件类型为前缀：tv_text,  tv_title;

 

 

选择器selector文件，sel加控件类型加名称

sel_btn_xxx

sel_tv_xxx

sel_cb_xxx

....

 

 

 

资源名称的命名

1，id命名

如果这个view需要填充数据，则命名跟服务器返回的字段一样，这样的话view就不需要在java那里初始化而直接赋值（框架方法直接赋值）

 

 

如果不需要填充，控件缩写加下划线加描述

控件               缩写

TextView           tv

Button             btn

ImageButton        imgb

ImageView         imgv

CheckBox          cb

RadioButton        rb

EditText           ed

WebView          wv

Spinner           spn

ScollView          sv

ListView           lv

Gridview          gv

LinearLayout       ln

RelativeLayout      rl