Android项目代码编写规范

本文详细介绍了Android项目中各类组件及文件的命名规范,包括包命名、类命名、变量命名、接口命名、方法命名及布局文件命名等,旨在提高代码的可读性和维护性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

包命名规范

包(packages):采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名为xxx(可以是公司域名或者个人命名),三级包名根据应用进行命名,四级包名为模块名或层级名。

  com.xxx.应用名称写.activity页面用到的Activity类(activities层级用户界面)
  com.xxx.应用名称缩写.fragment页面用到的Fragment类
  com.xxx.应用名称缩写.base页面中每个Activity类共享的可以写成一个BaseActivity类(基础共享的类)
  com.xxx.应用名称缩写.adapter页面各种的Adapter类(适配器的类)
  com.xxx.应用名称缩写.utils此包中包含:公共工具方法类(包含日期、网络、存储、日志等工具类)
  com.xxx.应用名称缩写.bean实体类
  com.xxx.应用名称缩写.db数据库操作
 com.xxx.应用名称写.view(或者.ui)自定义的View类等
com.xxx.应用名称缩写.serviceService服务
com.xxx.应用名称缩写.broadcast
Broadcast服务

类命名规范

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

Application类Application为后缀标识XXXApplication
Activity类Activity为后缀标识登录界面  LoginActivity
解析类Handler为后缀标识 
公共方法类Utils或Manager为后缀标识

线程池管理类:ThreadPoolManager

日志工具类:LogUtils

Service类以Service为后缀标识播放服务:PlayService
BroadcastReceiver类以Broadcast为后缀标识

时间通知:

TimeBroadcast

ContentProvider类以Provider为后缀标识单词内容提供者:DictProvider
直接写的共享基础类以Base为前缀

BaseActivity,

BaseFragment

数据库类以DBHelper后缀标识UserSQLiteDBHelper
   

变量命名规范

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

公开的常量:定义为静态final,名称全部大写。

如: public staticfinal String ALIPAY_APPID=”gdsfsf45sfswtsfsg”;

静态变量:名称以s开头 eg:

private static long userId= 0;

非静态的私有变量、protected的变量

以m开头,

如:private User mUser;


接口命名规范

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

           eg:

interface Runable;

  interface Accessible;


方法命名规范

方法(methods):动词或动名词,采用小驼峰命名法,

          eg:

                onCreate(),

run();

initXX()初始化相关方法,使用init为前缀标识,如初始化布局initView()
isXX()checkXX()方法返回值为boolean型的请使用is或check为前缀标识
getXX()返回某个值的方法,使用get为前缀标识
processXX()对数据进行处理的方法,尽量使用process为前缀标识
displayXX()弹出提示框和提示信息,使用display为前缀标识
saveXX()与保存数据相关的,使用save为前缀标识
resetXX()对数据重组的,使用reset前缀标识
clearXX()清除数据相关的
removeXX()清除数据相关的
drawXXX()绘制数据或效果相关的,使用draw前缀标识

布局文件命名规范

 全部小写,采用下划线命名法

1).contentview命名, Activity默认布局,以去掉后缀的Activity类进行命名。不加后缀:

功能模块.xml

eg:

login.xml、main.xml、settings.xml

       或者:activity_功能模块.xml

eg:

activity_login.xml、activity_main.xml

2).Dialog命名:dialog_描述.xml

eg:

dialog_tip.xml

3).PopupWindow命名:ppw_描述.xml

       eg:

ppw_info.xml

4). 列表项命名listitem_描述.xml

eg:listitem_city.xml

5).包含项:include_模块.xml

eg:include_head.xml、include_bottom.xml

6).adapter的子布局:功能模块_item.xml

eg:main_item.xml、


资源id命名规范

 命名模式为:view缩写_模块名称_view的逻辑名称

view的缩写详情如下:

常用

LayoutLayoutllt
RelativeLayoutrlt
  
  
  
  
  
  
  
  







评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值