wiki:spec

google 建议规范: http://source.android.com/source/code-style.html

中文翻译: http://blog.sina.com.cn/s/blog_48d491300100zwzg.html

格式

  • 代码缩进使用4个空格,不是Tab键。
  • 统一使用UTF-8编码,避免乱码问题。

Windows下Eclipese的具体设置见  http://hi.baidu.com/lane727/item/72339a5ee4958b19db163521
强烈推荐使用Android Studio

命名

禁止使用拼音

循环变量及简单的数学运算,可以使用约定俗成的 i, j, k , x, y, z, 其他变量名字请用英文全称或能看出意思的英文缩写。

为了别人更好的预读代码,关键的地方添加注释,注释可以是用中文

包命名

采用反域名命名规则,全部使用小写字母。一级包名为cn.com,二级包名为pc,三级包名根据应用进行命名,四级包名为模块名或层级名

例如:

cn.com.pc.应用.activities    此包中包含:页面用到的Activity类 (activities层级名 用户界面层)
cn.com.pc.应用.utils    此包中包含:公共工具方法类 
cn.com.pc.应用.db    此包中包含:数据库操作类
cn.com.pc.应用.custom    此包中包含:自定义的View类等
cn.com.pc.应用.service    此包中包含:Service服务
cn.com.pc.应用.broadcast    此包中包含:Broadcast服务
cn.com.pc.应用.model    此包中包含:应用使用到数据结构
类(classes)命名
名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的, 比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。
Activity 类   Activity为后缀标识,如欢迎页面类WelcomeActivity.
Adapter类    Adapter为后缀标识,如商品详情适配器ProductDetailAdapter
解析类       Handler为后缀标识,如首页解析类HomePosterHandler
公共方法类  Utils,Helper,Manager为后缀标识。如:线程池管理类:ThreadPoolManager,日志工具类:Utils,数据库工具:DbHelper
Service类   以Service为后缀标识
BroadcastReceive  以Broadcast为后缀标识
ContentProvider   以Provider为后缀标识
Model类  按实际意思命名
接口(interface)
命名规则与类一样采用大驼峰命名法,多以able或ible结尾,如interface Runnable ; interface Accessible 。
方法(methods)
动词或动名词,采用小驼峰命名法 例如:onCreate(),run()
initXXX()    初始化相关方法,使用init为前缀标识
isXXX()      checkXXX() 方法返回值为boolean型的请使用is或check为前缀标识
getXXX()     返回某个值的方法,使用get为前缀标识
processXXX() 对数据进行处理的方法,尽量使用process为前缀标识
displayXXX() 弹出提示框和提示信息,使用display为前缀标识
saveXXX()    与保存数据相关的,使用sav为e前缀标识
resetXXX()   对数据重组的,使用reset前缀标识
clearXXX()removeXXX()  清除数据相关的,使用clear或remove为前缀标识
drawXXX()     绘制数据或效果相关的,使用draw前缀标识
类属性命名
  • 非public的、非static的字段名称以m开头。
  • static字段名称以s开头。
  • 其它字段以小写字母开头。
  • public static final字段(常量)全部字母大写并用下划线分隔, 例如:MIN_WIDTH
  • 用统一的量词通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用mCustomerFirst和mCustomerLast,而不要使用mFirstCustomer和mLastCustomer。
量词列表:量词后缀说明
First  一组变量中的第一个
Last   一组变量中的最后一个
Next   一组变量中的下一个变量
Prev   一组变量中的上一个
Cur    一组变量中的当前变量

View对象命名

view变量命名:控件类型描述 + 意义描述

控件               缩写
TextView           tv
Button             btn
ImageButton        imgBtn
ImageView          iv
CheckBox           chk
RadioButton        rdoBtn
analogClock        anaClk
DigtalClock        dgtClk
DatePicker         dtPk
TimePicker         tmPk
toggleButton       tglBtn
EditText           et
ProgressBar        proBar
SeekBar            skBar
AutoCompleteTextView autoTxt
ZoomControls       zmCtl
Include            ind
VideoView          vdoVi
WdbView            webVi
RantingBar         ratBar
Tab                tab
Spinner            spn
Chronometer        cmt
ScollView          sclVi
TextSwitch         txtSwt
ImageSwitch        imgSwt
listView           lv
ExpandableList     epdLt
MapView            mapVi

XML文件(布局文件)
全部小写,采用下划线命名法

1.Activity默认布局,以去掉后缀的Activity类进行命名。不加后缀

2.Activity子布局,父布局名称开始,追加item 和子布局功能说明。

例如:Activity默认布局:homeposter.xml 子布局为homeposter_item_poster.xml

资源文件(图片)
全部小写,采用下划线命名法,加前缀区分
btn_login_normal 按钮图片使用btn_功能_说明
bg_head背景图片使用bg_功能_说明
def_search_cell默认图片使用def_功能_说明
icon_more_help图标图片使用icon_功能_说明
seg_list_line具有分隔特征的图片使用seg_功能_说明
sel_ok选择图标使用sel_功能_说明
动画文件(anim包)
全部小写,采用下划线命名法,加前缀区分。
click_head_left点击背景切换动画使用click前缀标识
bg_shape_rectangle背景自定义图形使用bg前缀标识
show_shopcar_add小动画效果使用show前缀标识