Android开发规范——命名

在讲解命名规范前,先初略介绍下当前主要的标识符命名法和英文缩写规则。

标识符命名法

标识符命名法最要有四种:

1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写。

2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字母大写

3 下划线命名法:单词与单词间用下划线做间隔。

4 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量前附加小写序列说明该变量的类型。 量的取名方式为:<scope_> + <prefix_> + <qualifier> 范围前缀,类型前缀,限定词。

个人觉得标识符命名原则:尽可能的用最少的字符而又能完整的表达标识符的含义。

英文缩写原则:
1 较短的单词可通过去掉“元音”形成缩写
2 较长的单词可取单词的头几个字母形成缩写
3 此外还有一些约定成俗的英文单词缩写.

下面为常见的英文单词缩写:
average   ---->  avg
background  --->bg
buffer ----->buf
control ---->ctrl
delete ----->del
document  ---->doc
error ----->err
escape ---->esc
increment ---->inc
infomation ---->info
initial  ---->init
image ---->img
Internationalization  ----> I18N
length --->len
library--->lib
message--->msg
password--->pwd
position--->pos
server--->srv
string --->str
temp--->tmp
window--->wnd(win)
程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。

命名规范:

1 包(packages): 采用反域名命名规则,全部使用小写字母。一级包名为com,二
级包名为anjoyo,三级包名根据应用进行命名,四级包名为模块名或层级名

例如:
com.anjoyo.应用.activities    此包中包含:页面用到的Activity类 (activities层级名 用户界面层)
com.anjoyo.应用.tools    此包中包含:公共工具方法类 (tools 模块名)
com.anjoyo.应用.db    此包中包含:数据库操作类
com.anjoyo.应用.custom    此包中包含:自定义的View类等
com.anjoyo.应用.service    此包中包含:Service服务
com.anjoyo.应用.broadcast    此包中包含:Broadcast服务

2 类(classes):名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的,
                 比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。

activity 类   Aty为后缀标识,如欢迎页面类WelcomeAty.
Adapter类    Adp为后缀标识,如商品详情适配器ProductDetailAdp
解析类       Hlr为后缀标识,如首页解析类HomePosterHlr
公共方法类  Tools或Manager为后缀标识。如:线程池管理类:ThreadPoolManager
            日志工具类:LogTools
数据库类    以DBHelper后缀标识。如城市数据库:CityDBHelper
Service类   以Service为后缀标识
BroadcastReceive  以Broadcast为后缀标识
ContentProvider   以Provider为后缀标识

3 接口(interface):命名规则与类一样采用大驼峰命名法,多以able或ible结尾,如interface Runna ble ;
                     interface Accessible 。

4 方法(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前缀标识

5 变量(variables)采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。

1 View变量命名:控件类型描述 + 意义描述
控件               缩写
TextView           txt
Button             btn
ImageButton        imgBtn
ImageView          imgView
CheckBox           chk
RadioButton        rdoBtn
analogClock        anaClk
DigtalClock        dgtClk
DatePicker         dtPk
TimePicker         tmPk
toggleButton       tglBtn
EditText           edtTxt
ProgressBar proBar    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           lVi
ExpandableList     epdLt
MapView            mapVi

用统一的量词通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。
量词列表:量词后缀说明
First  一组变量中的第一个
Last   一组变量中的最后一个
Next   一组变量中的下一个变量
Prev   一组变量中的上一个
Cur    一组变量中的当前变量
 
6 常量(constants)全部大写,采用下划线命名法.例如:MIN_WIDTH

7 XML文件(布局文件):全部小写,采用下划线命名法
  1.Activity默认布局,以去掉后缀的Activity类进行命名。不加后缀
  2.Activity子布局,父布局名称开始,追加item 和子布局功能说明。
例如:Activity默认布局:homeposter.xml   子布局为homeposter_item_poster.xml

8 资源文件(图片): 全部小写,采用下划线命名法,加前缀区分


btn_login_normal


按钮图片使用btn_功能_说明


bg_head


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


def_search_cell


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


icon_more_help


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


seg_list_line


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


sel_ok


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

9   动画文件(anim包):全部小写,采用下划线命名法,加前缀区分。


动画命名例子


规范写法


备注


click_head_left


点击背景切换动画使用click前缀标识


bg_shape_rectangle


背景自定义图形使用bg前缀标识


show_shopcar_add


小动画效果使用show前缀标识

10     资源ID(resources id):大小写规范与方法名一致,采用小驼峰命名法。命名规范为“资源控件的缩写  名”+“变量名”。注意:页面控件名称应该和控件id名保持一致

Android开发规范——命名

时间: 2024-11-05 13:08:19

Android开发规范——命名的相关文章

Android开发规范(编码+性能+UI)

现在为你带来Android开发规范,包括Android编码规范,Android性能优化以及Android UI优化. 一.Android编码规范 1.java代码中不出现中文,最多注释中可以出现中文 2.局部变量命名.静态成员变量命名 只能包含字母,单词首字母出第一个外,都为大写,其他字母都为小写 3.常量命名 只能包含字母和_,字母全部大写,单词之间用_隔开 4.layout中的id命名 命名模式为:view缩写_模块名称_view的逻辑名称 view的缩写详情如下 LayoutView:lv

Android开发规范

一.Android编码规范1.java代码中不出现中文,最多注释中可以出现中文2.局部变量命名.静态成员变量命名只能包含字母,单词首字母出第一个外,都为大写,其他字母都为小写3.常量命名只能包含字母和_,字母全部大写,单词之间用_隔开4.layout中的id命名命名模式为:view缩写_模块名称_view的逻辑名称view的缩写详情如下LayoutView:lvRelativeView:rvTextView:tvImageView:ivImageButton:imButton:btn5.acti

值得你学习的 Android 开发规范(上)

前言 AS规范 命名规范 资源文件规范 版本统一规范 第三方库规范 注释规范 其他的一些规范 1 前言 为了利于项目维护以及规范开发,促进成员之间Code Review的效率,故提出以下开发规范,如有更好建议,欢迎到GitHub提issue. GitHub:https://github.com/Blankj/AndroidStandardDevelop 2 AS规范 工欲善其事,必先利其器. 尽量使用最新版的IDE进行开发: 编码格式统一为UTF-8: 编辑完.java. .xml等文件后一定要

值得你学习的 Android 开发规范(下)

4 资源文件规范 4.1 资源布局文件(XML文件(layout布局文件)) 全部小写,采用下划线命名法 4.1.1 contentView命名 必须以全部单词小写,单词间以下划线分割,使用名词或名词词组. 所有Activity或Fragment的contentView必须与其类名对应,对应规则为:将所有字母都转为小写,将类型和功能调换(也就是后缀变前缀). 例如:activity_main.xml 4.1.2 Dialog命名 规则:dialog_描述.xml 例如:dialog_hint.x

旗鱼移动Android开发规范

撰写:     旗鱼移动Android开发组 旗鱼移动科技有限公司所属,未经允许不得私自传播 第1版 2016年 5 月 3 日 目录 一.Android开发框架 二.命名规范 2.1 包(packages)命名规范 2.2 类(classes)命名规范 2.3 方法(methods) 2.4 变量(variables) 2.5 常量(Constants) 2.6 资源文件(图片drawable文件夹下) 2.7 资源布局文件(XML文件(layout布局文件)) 2.8 资源布局文件(layo

Android 开发规范

一. 总包命名规范: 1. 主程序:com  . 公司简写 . 项目名称简写 如彩票主程序: com.whszzy.caipiao 2. 独立模块:com . 公司简写 . 项目名称简写 . 模块名称 如彩票Api :com.whszzy.caipiao.api 二. 具体模块包命名规范: 1. 共公单元    util            com.whszzy.caipiao.util 2. 自定义UI    ui             com.whszzy.caipiao.ui 3. 数

Android开发规范之编码规范

1,java代码中不出现中文,最多注释中可以出现中文,中文统一写在strings.xml中: 2,局部变量命名.静态成员变量命名 只能包含字母,单词首字母大写,其他字母都为小写3,常量命名只能包含字母和_,字母全部大写,单词之间用_隔开4,布局文件中的id命名命名模式为:view缩写_模块名称_view的逻辑名称常用控件的缩写如下LayoutView:lv_RelativeView : rv_TextView : tv_ImageView : iv_ImageButton : im_Button

【Android】Android开发规范的一点小体会

由于Java面向对象编程的特性, 在命名时应尽量选择名词 1.只有一个xxxApplication extends Application,初始化全局变量,Android使用Application总结 2.所有的xxxActivity extends BaseActivity,(BaseActivity extends Activity)初始化所有Activity用到的全局变量.方法. 3.所有的xxxFragment extends BaseFragment,(BaseFragment ext

android产品研发(一)--&gt;实用开发规范

从这篇文章开始我们暂停一下对android源码的分析,开始讲一下android产品研发中一些常用的技术,技巧,方法,实践等姿势.这里需要强调的是我们所讲解的这些东西可能对产品开发中比较常用的,因为对于项目开发中,可能更多的强调管理,进度方法的东西,对工程化的东西比较强调,而我们这里更多的是对产品技术方面的归纳总结. 而本文中选择将开发规范作为这个系列的第一篇文章,就是个人感觉产品研发过程中,开发规范真的很重要,很重要,非常重要(重要的事情说三遍),一个好的开发规范可以让团队中的人对他人的代码更熟