命名规范

 

一)  Layout命名

1．contentview命名：activity_功能模块.xml

例如：activity_main.xml、activity_more.xml

2．Dialog命名：dialog_描述.xml

       例如：dlg_hint.xml

2．PopupWindow命名：ppw_描述.xml

       例如：ppw _info.xml

3. 列表项命名listitem_描述.xml

       例如：listitem_city.xml

4．包含项：include_模块.xml

       例如：include_head.xml、include_bottom.xml

 

(二)  图片命名

1.       静态图片前缀_模块、前缀_模块_描述

例如：bg_main.png、ic_main_search.png

2.       动态图片前缀_模块_描述_状态、前缀_描述_状态

              例如：btn_film_buy_n.png、btn_film_buy_p.png、btn_back_n.png

       若是有多种形态如按钮等除外如btn_film_buy.xml（selector）

 

  我的习惯使用：android:id="@id/tvName"android:id="@id/listvName"、android:id="@id/tvHeadTitle",而后在class里的命名和id名字保持一致

(四)  字符串命名

       最好不要跟title、dialog、button等东西关系起来，直接用相同英文含义就能够了，若是下：

<string name="ok">肯定</string>

<string name=" welcome_to_use">欢迎使用</string>

 

再举一些很差的例子，以下<string name="menu_ok ">肯定</string>

 

(五)  控件命名

控件缩写_描述

例如：TextViewtv_name、Button btn_buy、LinearLayoutllyt_body;

 

(六)  类命名

功能模块Activity.class  功能模块Service.class

如：MainActivity.class  HuaFuBaoActivity.classAppUpgradeService.class

命名规范：
1  包（packages）: 采用反域名命名规则，所有使用小写字母。一级包名为com，二级包名为xx（能够是公司或则我的的随便），三级包名根据应用进行命名，四级包名为模块名或层级名

包名   
此包中包含
com.xx.应用名称缩写.activities
   
页面用到的Activity类 (activities层级名用户界面层)
com.xx.应用名称缩写.base
     页面中每一个Activity类共享的能够写成一个i额BaseActivity类 (基础共享的类)

com.xx.应用名称缩写.adapter 
    页面用到的Adapter类 (适配器的类)

com.xx.应用名称缩写.tools
    此包中包含：公共工具方法类（tools模块名）

com.xx.应用名称缩写.bean
    (或则 com.xx.应用名称缩写.unity )
    此包中包含：元素类

com.xx.应用名称缩写.db   
    数据库操做类

com.xx.应用名称缩写.view

    (或则 com.xx.应用名称缩写.ui )   
     自定义的View类等

com.xx.应用名称缩写.service   
    Service服务

com.xx.应用名称缩写.broadcast     
    Broadcast服务
2  类（classes）：名词，采用大驼峰命名法，尽可能避免缩写，除非该缩写是众所周知的，  好比HTML,URL，若是类名称中包含单词缩写，则单词缩写的每一个字母均应大写。   
描述   
例如
activity 类   
     Aty或者Activity为后缀标识
     欢迎页面类WelcomeAty.或者WelcomeActivity

Adapter类   
     Adp或者Adapte 为后缀标识   
     新闻详情适配器NewtDetailAdp或则直接  NewDetailAdapter

解析类
     Hlr为后缀标识
       首页解析类HomePosterHlr
 
公共方法类
    Tools或Manager为后缀标识
   

线程池管理类：ThreadPoolManager
        日志工具类：LogTools

数据库类
    以DBHelper后缀标识
   
新闻数据库：NewDBHelper

    Service类
    以Service为后缀标识   
    时间服务TimeService

BroadcastReceive类:以Broadcast为后缀标识时间通知TimeBroadcast
ContentProvider:以Provider为后缀标识
 
直接写的共享基础类: 以Base开头 BaseActivity,BaseFragment

3  接口（interface）：命名规则与类同样采用大驼峰命名法，多以able或ible结尾，如interface Runna ble ;
                     interface Accessible 。

4  方法（methods）：动词或动名词，采用小驼峰命名法例如:onCreate(),run()

initXX():初始化相关方法,使用init为前缀标识，如初始化布局initView()

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

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

processXX() :对数据进行处理的方法，尽可能使用process为前缀标识

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

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

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

clearXX():清除数据相关的

removeXXX() :清除数据相关的

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

 

6  常量（Constants）所有大写,采用下划线命名法.例如：MIN_WIDTH

7  资源文件（图片drawable文件夹下）：所有小写，采用下划线命名法，加前缀区分

命名模式：activity名称_逻辑名称/common_逻辑名称

若是有多种形态如按钮等除外如btn_xx.xml（selector）

名称_功能

btn_xx :按钮图片使用btn_总体效果（selector）

btn_xx_normal :按钮图片使用btn_正常状况效果

btn_xx_press: 按钮图片使用btn_点击时候效果

bg_head:背景图片使用bg_功能_说明

def_search_cell: 默认图片使用def_功能_说明

icon_more_help:图标图片使用icon_功能_说明

seg_list_line:具备分隔特征的图片使用seg_功能_说明

sel_ok:选择图标使用sel_功能_说明

命名后缀：
后缀说明
unit:在使用xml的tilemode来配图片时，element图片使用此后缀
nor:图片的状态，表明普通状态
hl:图片的状态，表明高亮状态
press:图片的状态，表明按下状态
select:图片的状态，表明其所占的view被选中
unselect:图片的状态，表明其所占的view没有被选中

8     资源布局文件（XML文件（layout布局文件））：
所有小写，采用下划线命名法

1)．contentview命名, Activity默认布局，以去掉后缀的Activity类进行命名。不加后缀：
       功能模块.xml
    例如：main.xml、more.xml、settings.xml
        或则：activity_功能模块.xml
        例如：activity_main.xml、activity_more.xml
2)．Dialog命名：dialog_描述.xml
       例如：dlg_hint.xml
2)．PopupWindow命名：ppw_描述.xml
       例如：ppw _info.xml
3). 列表项命名listitem_描述.xml
       例如：listitem_city.xml
4)．包含项：include_模块.xml
       例如：include_head.xml、include_bottom.xml
5)．adapter的子布局：功能模块_item.xml
       例如：main_item.xml、

9   动画文件（anim文件夹下）：所有小写，采用下划线命名法，加前缀区分。
//前面为动画的类型，后面为方向
动画命名例子   
规范写法    备注

fade_in : 淡入
fade_out :淡出   
push_down_in:从下方推入
push_down_out:从下方推出
push_left:推像左方
slide_in_from_top:从头部滑动进入
zoom_enter:变形进入
slide_in:滑动进入
shrink_to_middle:中间缩小

10    资源ID（resourcesid）：大小写规范与方法名一致，采用小驼峰命名法。命名规范为“资源控件的缩写  名”+“变量名”。注意：页面控件名称应该和控件id名保持一致
strings.xml，colors.xml等中的id命名：
命名模式：activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称
strings.xml中，使用activity名称注释，将文件内容区分开来
11   layout中的id命名
命名模式为：view缩写_模块名称_view的逻辑名称
view的缩写详情以下：

控件 缩写

LayoutView     lv
RelativeView    rv
TextView     tv
Button        btn
ImageButton     imgBtn
ImageView    mgView 或则 iv
CheckBox    chk
RadioButton    rdoBtn
analogClock        anaClk
DigtalClock        dgtClk
DatePicker         dtPk
EditText           edtTxt
TimePicker         tmPk
toggleButton       tglBtn
ProgressBar proBar
SeekBar                            skBar
AutoCompleteTextView    autoTxt
ZoomControls       zmCtl
VideoView         vdoVi
WdbView            webVi
RantingBar         ratBar
Tab                tab
Spinner                spn
Chronometer       cmt
ScollView          sclVi
TextSwitch         txtSwt
ImageSwitch            imgSwt
listView               lVi 或则lv
ExpandableList         epdLt
MapView                mapVi

12.activity中的view变量命名

命名模式为：逻辑名称+view缩写

建议：若是layout文件很复杂，建议将layout分红多个模块，每一个模块定义一个moduleViewHolder，其成员变量包含所属view

13.styles.xml：将layout中不断重现的style提炼出通用的style通用组件，放到styles.xml中；