Changes between Version 1 and Version 2 of spec


Ignore:
Timestamp:
09/02/2014 11:24:31 AM (12 years ago)
Author:
liaojiaohe
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • spec

    v1 v2  
    1 google 建议规范:http://source.android.com/source/code-style.html[[BR]] 
     1google 建议规范:http://source.android.com/source/code-style.html [[BR]] 
    22 
    3 中文翻译:http://blog.sina.com.cn/s/blog_48d491300100zwzg.html[[BR]] 
     3中文翻译:http://blog.sina.com.cn/s/blog_48d491300100zwzg.html [[BR]] 
    44 
    55 
     
    1818== '''命名''' == 
    1919 
     20'''''禁止使用拼音''''' 
     21 
    2022 包命名:: 
    2123 
    22  
    2324   采用反域名命名规则,全部使用小写字母。一级包名为cn.com,二级包名为pc,三级包名根据应用进行命名,四级包名为模块名或层级名 
    24  
    2525 
    2626例如:[[BR]] 
    2727{{{ 
    2828cn.com.pc.应用.activities    此包中包含:页面用到的Activity类 (activities层级名 用户界面层) 
    29 cn.com.pc.应用.tools    此包中包含:公共工具方法类 (tools 模块名) 
     29cn.com.pc.应用.utils    此包中包含:公共工具方法类  
    3030cn.com.pc.应用.db    此包中包含:数据库操作类 
    3131cn.com.pc.应用.custom    此包中包含:自定义的View类等 
    3232cn.com.pc.应用.service    此包中包含:Service服务 
    3333cn.com.pc.应用.broadcast    此包中包含:Broadcast服务 
     34cn.com.pc.应用.model    此包中包含:应用使用到数据结构 
    3435}}} 
    35  属性命名:: 
     36 
     37 类(classes)命名:: 
     38      名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的, 比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。[[BR]] 
     39 
     40{{{ 
     41Activity 类   Activity为后缀标识,如欢迎页面类WelcomeActivity. 
     42Adapter类    Adapter为后缀标识,如商品详情适配器ProductDetailAdapter 
     43解析类       Handler为后缀标识,如首页解析类HomePosterHandler 
     44公共方法类  Utils,Helper,Manager为后缀标识。如:线程池管理类:ThreadPoolManager,日志工具类:Utils,数据库工具:DbHelper 
     45Service类   以Service为后缀标识 
     46BroadcastReceive  以Broadcast为后缀标识 
     47ContentProvider   以Provider为后缀标识 
     48Model类  按实际意思命名 
     49}}} 
     50 
     51 接口(interface):: 
     52        命名规则与类一样采用大驼峰命名法,多以able或ible结尾,如interface Runnable ; interface Accessible 。[[BR]] 
     53 
     54 方法(methods):: 
     55     动词或动名词,采用小驼峰命名法 例如:onCreate(),run()  [[BR]] 
     56 
     57 
     58{{{ 
     59initXXX()    初始化相关方法,使用init为前缀标识 
     60isXXX()      checkXXX() 方法返回值为boolean型的请使用is或check为前缀标识 
     61getXXX()     返回某个值的方法,使用get为前缀标识 
     62processXXX() 对数据进行处理的方法,尽量使用process为前缀标识 
     63displayXXX() 弹出提示框和提示信息,使用display为前缀标识 
     64saveXXX()    与保存数据相关的,使用sav为e前缀标识 
     65resetXXX()   对数据重组的,使用reset前缀标识 
     66clearXXX()removeXXX()  清除数据相关的,使用clear或remove为前缀标识 
     67drawXXX()     绘制数据或效果相关的,使用draw前缀标识 
     68}}} 
     69 
     70 
     71 类属性命名:: 
    3672 
    3773    * 非public的、非static的字段名称以m开头。[[BR]] 
    3874    * static字段名称以s开头。[[BR]] 
    3975    * 其它字段以小写字母开头。[[BR]] 
    40     * public static final字段(常量)全部字母大写并用下划线分隔[[BR]] 
     76    * public static final字段(常量)全部字母大写并用下划线分隔, 例如:MIN_WIDTH [[BR]] 
     77    * 用统一的量词通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用mCustomerFirst和mCustomerLast,而不要使用mFirstCustomer和mLastCustomer。 
     78 
     79{{{ 
     80量词列表:量词后缀说明 
     81First  一组变量中的第一个 
     82Last   一组变量中的最后一个 
     83Next   一组变量中的下一个变量 
     84Prev   一组变量中的上一个 
     85Cur    一组变量中的当前变量 
     86 
     87}}} 
     88 
     89 View对象命名:: 
     90 
     91view变量命名:控件类型描述 + 意义描述 
     92 
     93{{{ 
     94控件               缩写 
     95TextView           txt 
     96Button             btn 
     97ImageButton        imgBtn 
     98ImageView          imgView 
     99CheckBox           chk 
     100RadioButton        rdoBtn 
     101analogClock        anaClk 
     102DigtalClock        dgtClk 
     103DatePicker         dtPk 
     104TimePicker         tmPk 
     105toggleButton       tglBtn 
     106EditText           edtTxt 
     107ProgressBar proBar    proBar 
     108SeekBar                            skBar 
     109AutoCompleteTextView autoTxt 
     110ZoomControls       zmCtl 
     111Include            ind 
     112VideoView          vdoVi 
     113WdbView            webVi 
     114RantingBar         ratBar 
     115Tab                tab 
     116Spinner            spn 
     117Chronometer        cmt 
     118ScollView          sclVi 
     119TextSwitch         txtSwt 
     120ImageSwitch        imgSwt 
     121listView           lVi 
     122ExpandableList     epdLt 
     123MapView            mapVi 
     124 
     125}}} 
     126 
     127 
     128 XML文件(布局文件):: 
     129  全部小写,采用下划线命名法[[BR]] 
     130 
     131  1.Activity默认布局,以去掉后缀的Activity类进行命名。不加后缀[[BR]] 
     132 
     133  2.Activity子布局,父布局名称开始,追加item 和子布局功能说明。[[BR]] 
     134 
     135例如:Activity默认布局:homeposter.xml   子布局为homeposter_item_poster.xml[[BR]] 
     136 
     137 
     138 资源文件(图片):: 
     139  全部小写,采用下划线命名法,加前缀区分[[BR]] 
     140 
     141||btn_login_normal || 按钮图片使用btn_功能_说明 || 
     142||bg_head||背景图片使用bg_功能_说明|| 
     143||def_search_cell||默认图片使用def_功能_说明|| 
     144||icon_more_help||图标图片使用icon_功能_说明|| 
     145||seg_list_line||具有分隔特征的图片使用seg_功能_说明|| 
     146||sel_ok||选择图标使用sel_功能_说明|| 
     147 
     148 动画文件(anim包):: 
     149  全部小写,采用下划线命名法,加前缀区分。 
     150  
     151||click_head_left||点击背景切换动画使用click前缀标识|| 
     152||bg_shape_rectangle||背景自定义图形使用bg前缀标识|| 
     153||show_shopcar_add||小动画效果使用show前缀标识||