Android代码命名规范

来源:互联网 发布:网络主播行业调查分析 编辑:程序博客网 时间:2024/05/18 00:41
对命名进行规范可以提高代码的可读性,一个好的命名方式,能很轻易的知道变量或者方法或者对象的意义,正所谓的顾名思义。命名方式没有美丑对错之分,关键在于统一,整个项目使用统一的命名方式是很有必要的。

类的命名规范: 
如果是Android SDK提供的Android应用组成部分,那么类名应该是类的作用的英文全称或者缩写+ Android SDK基类的名字。
例子:Activity类名字应该是 类似 MainActivity, NaviActivity (Navigation, 导航缩写Navi), TextActivity, BookActivity, Service类名字缩写应该是类似 DownloadService
如果不是以Android SDK提供的Android应用组成部分,那么类名应该是类的作用的英文名字,首字母大写,如:ProductListAdapter, JsonHTTPSRequest

接口命名规范:
命名规则与类一样采用大驼峰命名法,多以able、ible或者Listener结尾。例如:interface Runable, interface Accessible,ActionCallbackListener

成员变量命名规范,采用小驼峰命名法:
临时变量命名
使用标准的Java命名方法,不推荐使用Google的m命名法。例如:
private String userName; 而不推荐使用 private String mUserName;

常量命名
常量使用全大写字母加下划线的方式命名。例如:
public static final String TAG = "tag";

控件实例命名
类中控件名称必须与xml布局id保持一致(可以去掉{module_name})。例如:
在布局文件中 Button 的id为: android:id="@+id/btn_pay"
private Button btnPay//也可以把空间实例当做临时变量来命名

方法命名规范
动词或动名词,采用小驼峰命名法。例如:run(), onCreate(), syncProducts();

资源string文件的命名规范:
页面标题,命名格式为:title_{页面}
按钮文字,命名格式为:btn_{按钮事件}
标签文字,命名格式为:label_{标签文字}
选项卡文字,命名格式为:tab_{选项卡文字}
消息框文字,命名格式为:toast_{消息}
编辑框的提示文字,命名格式为:hint_{提示信息}
图片的描述文字,命名格式为:desc_{图片文字}
对话框的文字,命名格式为:dialog_{文字}

布局文件(Layout)命名规范
全部小写,采用下划线命名法。其中{module_name}为业务模块或是功能模块等模块化的名称或简称。
activity layout: {module_name}_activity_{名称} 例如:
crm_activity_main.xml | crm_activity_shopping.xml
fragment layout:{module_name}_fragment_{名称} 例如:
crm_fragment_main.xml | crm_fragment_shopping.xml
Dialog layout: {module_name}_dialog_{名称} 例如:
crm_dialog_loading.xml

列表项布局命名:{module_name}_list_item_{名称} 例如:
crm_list_item_customer.xml
包含项布局命名:include_{名称} 例如:
include_head.xml
adapter的子布局: {module_name}_item_{名称} 例如:
qz_item_order.xml
widget layout: {module_name}_widget_{名称} 例如:
crm_widget_shopping_detail.xml

图标命名:
{module_name}_ic_{名称} 例如:
crm_ic_app.png

背景图片命名: {module_name}_bg_{名称} 例如:
crm_bg_navbar_highlight_normal.9.png

按钮Button命名: {module_name}_btn_{名称} 例如:
crm_btn_login_normal.9.png

按钮checkbox图片命名:{module_name}_checkbox_{名称} 例如:
crm_checkbox_cart_true.png

其他图片命名:{module_name}_icon_{名称} 例如:
qz_icon_blue_circle.png
0 0
原创粉丝点击