命名规则

合集下载
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

包名

类名

接口名

回调事件监听接口 On + 对象 + Click/Select,例如:OnItemClick/OnMenuSelect 其他接口功能描述 + Impl

方法名

类的属性命名

1.常量名

常量名命名模式为CONSTANT_CASE,全部字母大写,用下划线分隔单词

常量一般统一放置在config目录下的AppConfig文件内

同类型的常量,通常放置在同一个内部类中示例参考 com.xiaoq.sample.mylib.code包下面的Appconfig

2.非常量字段名

非公有,非静态字段命名以m开头。

int mPackagePrivate;

private int mPrivate;

protected int mProtected;

静态字段命名以s开头。

private static MyClass sSingleton;

公有非静态字段命名以p开头。

public int pField;

公有静态字段(全局变量)命名以g开头。

public static int gField;

UI控件变量命名参考附录的 UI控件缩写表

3.量词变量后缀

First 一组变量中的第一个 Last 一组变量中的最后一个 Next 一组变量中的下一个变量 Prev 一组变量中的上一个 Cur 一组变量中的当前变量。例如:mCustomerStrFirst mCustomerStrLast

4.集合添加如下后缀:List、Map、Set

5.数组添加如下后缀:Arr

6.临时变量

临时变量通常被取名为i,j,k,m和n,它们一般用于整型; c,d,e,它们一般用于字符型;

资源文件命名规范

1.资源布局文件(XML文件(layout布局文件)):

activity_main.xml frament_main.xml Dialog命名:dialog_描述.xml,例如:dialog_hint.xml PopupWindow命名:ppw_描述.xml,例如:ppw_info.xml 列表项命名:item_描述.xml

通用列表项:item_city.xml listview:list_item_city.xml gridview:

grid_item_city.xml recyclerview:recycler_item_city.xml 自定义类似listview:TabLayout:tab_item_city.xml 包含项命名:模块_(位置).xml

位置:top、 btm、 left、 right 例如:activity_main_btm.xml、

fragment_main_top.xml 通用的包含项命名采用:base_(位置)_项目名称缩写_描述.xml 描述:title、 content、 header、 footer 例如:

base_top_xxxx_title.xml、base_btm_xxxx_header.xml 例如:全项目通用base_top.xml base_btm.xml 自定义Widget(布局命名)

widget_ + View功能描述/模块 + 类型(list/info) + .xml 例如:订单详情内的商品列表 widget_order_detail_goods_list.xml 特殊自定义组件/控件

例如: com.xiaoq.widget.tips.TipsManager的loading布局/empty布局/重试布局通用:base_tips_loading.xml、base_tips_empty、base_tips_retry 各个activity内:activity_描述_tips_loading.xml、

activity_main_tips_loading.xml fragment:fragment_main_tips_loading.xml view:activity_main_xxx_view_tips_loading.xml、

fragment_main_xxx_view_tips_loading.xml,xxx 为view的描述

2.资源文件(图片mipmap及drawable文件夹下):

- divider_maket_white.png 分割线

- btn_red.png 红色按键

- btn_red_big.png 红色大按键

- divider_white.png 白色分割线

- 如果有多种形态如按钮等除外如 btn_xx.xml(selector)

3.动画文件(anim文件夹下):

4.styles.xml文件的命名

规则:模块名+逻辑名称

main_tabBottom order_detail_goodsItem order_list_goodsImg

5. layout中的id命名

命名模式为:View缩写_view的逻辑名称,可以使用Android Studio的插件Android Studio Prettify 自动生成findViewById 例如:tv_Sender_Mobile (展示联系人手机的TextView)可参考

com.xiaoq.sample.mylib.code.CodeActivity 当然,全部小写的命名是最标准的,不过为了要适应Prettify插件自动生成满足要求的局部变量,调整为小驼峰命名法,并用下划线分割

附录

注意

其他未在文档内标准的规范则以AndroidStudio自动生成的为准

UI控件缩写表

常见英文单词缩写

相关文档
最新文档