文档库 最新最全的文档下载
当前位置:文档库 › Android编程规范20150717

Android编程规范20150717

Android编程规范20150717

1、package命名和结构

com.dobell.dox

act 和界?面强相关的东?西

activity 各种Acitivty

adapter 各种Adapter

base 基础?父类

event 事件类

item adpterview的item布局

listener 监听器

widget 封装好的?小控件

component 组件

constants 常量

dao 实体及其操作类

netwotk ??网络

service 服务

utils ?工具类集合

?二、命名规范

1、class 类

采?用?大驼峰命名法,除?非约定,尽量避免缩写。

类别描述实例

后缀法Activity、Fragment、Dialog、

Service、Adapter、Button、

Runnable、Event、Listener、Item、

Utils、Dao等WelcomeActivity、ColorFragment、LogoutDialog、PostBlogService、ContactAdapter、CircleButton、AddFriendRunnable、ReceiveMsgEvent、Okay 等

前缀法?父类加Base BaseActivity、

BaseRunnable等

2、interface 接?口

接?口根据不同场景,有如下?几种命名?方法:

以I开头,如interface ICallback,interface IView;

以able/ible结尾,如interface Runnable

以Listener结尾,如interface NetworkStateListener

3、method ?方法

采?用?小驼峰命名法,?一般来说是动词性质,参数不宜过多。

下?面给出常?见的动词前缀,以供参考。

initXX isXX getXX setXX saveXX loadXX updateXX removeXX addXX clearXX resetXX onXX beforeXX afterXX refreshXX handleXX runXX callXX showXX hideXX checkXX

4、variaible 变量

采?用?小驼峰命名法。变量名不应以下划线或美元符号开头,变量名应简短且富于描述,能够指出其?用途。尽量避免单个字符的变量名,除?非是?一次性的临时变量。如果不是公共静态变量,以字?母m开头。举例: mContactAdapter、mCheckRunnable、mCurPostion、mScreenWidth。特别地,控件名和xml中得id?一致。

5、Constant 常量

全部?大写,下划线连接单词,例如:MAX_PIC_COUNT

6、Layout 布局

全部?小写,下划线连接单词,从总体到局部命名,如:

act_setting_update.xml (设置-更新Acitivity的布局)

dlg_contact_remove.xml(联系?人-删除好友对话框布局)

item_square_topic.xml(??广场-话题的item项布局)

7、id命名

?小驼峰命名法,第?一个单词是该控件的性质,例如:btCon?rm(确定按钮)、ivHead(头像图?片)

具体缩写如下

LinearLayout-ll RelativeLayout-rl FrameLayout-? TextView-tv Button-bt ImageButton-ibt CheckBox-cb RadioButton-rb EditText-et ImgeView-iv ListView-lv GridView-gv 等

8 resourcesid 资源id

全部?小写,下划线连接单词,从类别_模块_?用途_状态来命名,如:

icon_actionbar_delete_pressed.png(顶栏删除按下状态的icon)

selecor_setting_item_bg.png(设置界?面每个item的背景selector)

三、注释

1、对类的注释

/**

* 类名

* @author 作者

* 主要?用途

**/

2、对?方法的注释

/**

* ?一句话概述功能

* 如果复杂,需要进?行详细描述

* @params 说明参数含义

* @return 说明返回值含义,尤其要说明返回值是否可能为null

* @throw XXException 说明此异常发?生的条件

**/

3、类成员变量和常量的注释

/**

* 说明含义

**/

4、?方法内部的注释使?用单?行注释// xxxxxx,不可使?用javadoc的?方式。

三、注释

1、缩进不要使?用tab,?用4个空格代替,断?行定义为8个空格

2、?一个?方法尽量不要超过40?行,?一?行最?大字符为100个

3、如果代码是短暂的、短期的、不完善的,使?用TODO注释

4、数据库语句关键字?大写

相关文档