Android代码规范

最新推荐文章于 2024-08-05 19:30:53 发布
最新推荐文章于 2024-08-05 19:30:53 发布
阅读量522 收藏
点赞数
分类专栏： Android精华教程 文章标签： android 规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/dengchenhe/article/details/44923463
版权

开始之前请详细阅读并遵守Android开发者代码风格指南不要使用拼音命名名称应简洁而富于描述，使用完整单词，避免使用缩写（除非该缩写被更广泛使用，例如URL、HTML）代码中不要出现中文标点字符，例如：‘，’、‘：’注释中可以书写中文标点字符，便于阅读注释遵循英文写作习惯，英文标点符号后空一格，避免句子紧凑颜色色值的字母必须全部大写

命名规则

1. 包命名

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

包名说明
com.xxx.应用名称缩写.activitiesActivity类
com.xxx.应用名称缩写.fragmentFragment类
com.xxx.应用名称缩写.baseBaseActivity类（基础共享的类）
com.xxx.应用名称缩写.adapterAdapter类
com.xxx.应用名称缩写.utils此包中包含：公共工具方法类（包含日期、网络、存储、日志等工具类）
com.xxx.应用名称缩写.bean（model/domain均可）实体类
com.xxx.应用名称缩写.db数据库操作
com.xxx.应用名称缩写.view（或.ui自定义的View类等
com.xxx.应用名称缩写.serviceService服务
com.xxx.应用名称缩写.broadcastBroadcast广播
com.xxx.应用名称缩写.net网络相关

2. 类命名

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

类描述例如
Application类Application为后缀标识XXXApplication
Activity类Activity为后缀标识闪屏页面类SplashActivity
解析类Handler为后缀标识
公共方法类Utils或Manager为后缀标识线程池管理类：ThreadPoolManager；日志工具类：LogUtils
数据库类以DBHelper后缀标识MySQLiteDBHelper
Service类以Service为后缀标识播放服务：PlayService
BroadcastReceiver类以Broadcast为后缀标识时间通知：TimeBroadcast
ContentProvider类以Provider为后缀标识单词内容提供者：DictProvider
直接写的共享基础类以Base为前缀BaseActivity；BaseFragment

3. 方法的命名

方法（methods）：动词或动名词，采用小驼峰命名法

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

4. 变量的命名

变量（variables）：采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。
公开的常量：定义为静态final，名称全部大写

public staticfinal String ACTION_MAIN="android.intent.action.MAIN";

静态变量：名称以s开头 

private static long sInstanceCount = 0;

非静态的私有变量、protected的变量：以m开头

private Intent mItent;

5. 接口的命名

接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾

interface Runable; interface Accessible;

6. 异常的命名

名称必须以Exception结尾。

NullPointerException

7. 布局文件的命名

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

名称事例
功能模块main.xml；more.xml；settings.xml
activity_功能模块activity_main.xml；activity_more.xml
Dialog命名：dialog_描述.xmldlg_hint.xml
PopupWindow命名：ppw_描述.xmlppw_info.xml
列表项命名listitem_描述.xmllistitem_city.xml
包含项：include_模块.xmlinclude_head.xml；include_bottom.xml
dapter的子布局：功能模块_item.xmlmain_item.xml

8. 资源ID的命名

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

控件缩写
RelativeLayoutrlyt
LinearLayoutllyt
TableLayouttlyt
FrameLayoutflyt
TextViewtv
EditTextet
Buttonbtn
ImageButtonibtn
RadioButtonrbtn
ToggleButtontbtn
CheckBoxchk
Viewv
ImageViewiv
ListViewlv
ScrollViewsclv
ProgressBarpbar

9. 图片的命名

name是模块的名称或功能的描述。

图片名称一般由模块名称/功能描述 + 后缀组成，后缀是可选的。

命名说明
bg_xxx这种图片一般那些比较大的图片，比如作为某个Activity的背景等
btn_xxx按钮，一般用于按钮，而且这种按钮没有其他状态
ic_xxx图标，一般用于单个图标，比如启动图片ic_launcher
sl_xxx状态图片
bg_描述状态1[状态2]用于控件上的不同状态
btn_描述状态1[状态2]用于按钮上的不同状态
chx_描述状态1[状态2]选择框，一般有2态和4态

10. 动画文件命名

动画文件（anim文件夹下）：全部小写，采用下划线命名法，加前缀区分。前面为动画的类型，后面为方向。

动画命名备注
fade_in淡入
fade_out淡出
push_down_in从下方推入
push_down_out从下方推出
push_left推像左方
slide_in_from_top从头部滑动进入
zoom_enter变形进入
slide_in滑动进入
shrink_to_middle中间缩小

注释

养成良好的注释习惯，对提升自己的编程能力和团队合作能力有很大的益处。

1. 文件注释

源文件的开头需要注释说明当前的文件信息，包括文件名、作者、版本信息、日期、修改记录等。

*
 1. -----------------------------------------------------------------
 2. Copyright (C) 2007-2014, by HuaShengRun, Shenzhen, All rights reserved.
 3. -----------------------------------------------------------------
 4.  5. File: RequestManager.java
 6. Author: JiongBull
 7. Version: 1.0
 8. Create: 2014-8-10
 9.  10. Changes (from 2014-8-10)
 11. -----------------------------------------------------------------
 12. 2014-8-10 : 创建 RequestManager.java (JiongBull);
 13. -----------------------------------------------------------------
*/

2 类注释

在类的开头添加类信息的描述.

/**
 1. 管理Volley的Request, 使用之前需要调用init()进行初始化.
*/
public class RequestManager {
}

3. 方法注释

一般情况下需要为每个方法添加注释，包括方法的功能描述，参数信息、返回值、异常信息等，有些约定俗成的方法可以不需要添加注释，请参考约定俗成的说明。

/**
 1. 输出日志.
 2.  3. @param context Context
 4. @param logLevel 日志等级
 5. @param tag 标签
 6. @param content 输出内容
 7. @param throwable 异常信息, 若没有异常可为空
*/
private static void trace(final Context context, final int logLevel, final String tag, final String content, final Throwable throwable) {
...
}

4. 域变量和常量注释

/**
* 日志的扩展名.
*/
public static final String LOG_EXTENSION = ".log";

/**
 1. 网络请求队列.
*/
private RequestQueue mRequestQueue;

5. 其他注释

  • 单行注释
view.setImageResource(defaultImageResId); // 无图片显示默认图片
  • 区块注释
/* 网络图片添加渐变动画 */
Resources resource = mContext.getResources();
final TransitionDrawable transitionDrawable =
new TransitionDrawable(new Drawable[] {
    new ColorDrawable(android.R.color.transparent),
    new BitmapDrawable(resource, bmpResponse)
});
view.setBackgroundResource(defaultImageResId);
view.setImageDrawable(transitionDrawable);
transitionDrawable.startTransition(RequestManager.FADE_IN_TIME);

6. XML注释

约定俗成

1. get / set 方法的注释

通过IDE工具批量生成域变量的 get / set 方法可以不用注释。

2. 第三方库生成代码的注释

第三方库生成的代码可以不用注释，例如greenDao生成的代码。

3. 通用类的注释

通用类的公共方法应全部添加注释。

4. 一般情况下的注释

例如在activity、service等文件中，只需对关键的类变量进行注释，方法建议全部添加注释

iDarren_he
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
android代码规范
08-31
以下是一些关键的Android代码规范要点： 1. **命名规范**： - 类名：使用大驼峰命名法，如`MainActivity`。 - 变量名和方法名：使用小驼峰命名法，如`textView`，`fetchData()`。 - 常量：全大写字母，用下划线...
AndroidCodeStandard:Android代码规范文档
03-05
Android代码规范文档 云地址： 做开源几年了，被很多人夸大，你的代码写得比较规范，，但是迟迟没有出一个代码规范，说来惭愧，只是因为我早几年写的代码还不够规范，不敢出来误导大家，而代码规范是后续才慢慢养成...
Android HTTP网络通信（二）：Volley框架——介绍、基本用法
iDarren的博客
03-18 826
简介什么是Voliey发布时间：Google I/O 2013时期Volley是Android平台上的网络通信库，能使网络通信更快，更简单，更健壮。Volley可是说是把AsyncHttpClient和Universal-Image-Loader的优点集于了一身，既可以像AsyncHttpClient一样非常简单地进行HTTP通信，也可以像Universal-Image-Loader一样轻松加载网络
Android HTTP网络通信（一）：使用HttpURLConnection、HttpClient
iDarren的博客
03-18 808
目前，大多数的Android应用程序都会使用HTTP协议来发送和接收网络数据，而Android中主要提供了两种方式来进行HTTP操作，HttpURLConnection和HttpClient。GET和POST的对比举个例子：get方式类似于明信片，只有请求头，没有请求体。而post方式类似于一封信，信封上的内容为请求头；信里面的内容为请求体（请求头和请求体是分开的）。含义 GET：通过请求URI得到
Android数据存储（一）：SharedPreferences存储
iDarren的博客
03-18 730
简介SharedPreferences是使用键值对的方式来存储数据的。也就是说当保存一条数据时，需要给这条数据提供一个对应的键，这样在读取数据的时候就可以通过这个键把相应的值取出来。而且SharedPreferences还支持多种不同的数据类型存储，如果存储的数据类型是整型，那么读取出来的数据也是整型的，存储的数据是一个字符串，读取出来的数据仍然是字符串。将数据存储到SharedPreference
Android HTTP网络通信（三）：Volley框架——定制Request
iDarren的博客
03-18 645
上一篇文章我们已经掌握了Volley各种Request的使用方法，包括StringRequest、JsonRequest、ImageRequest等。其中StringRequest用于请求一条普通的文本数据，JsonRequest(JsonObjectRequest、JsonArrayRequest)用于请求一条JSON格式的数据，ImageRequest则是用于请求网络上的一张图片。我们都知道，在
Android数据存储（二）：SQLite存储
iDarren的博客
03-19 618
简介SQLite是一款轻量级的关系型数据库，运算速度快，占用资源少，通常只需要几百K的内存就足够了，因而特别适合在移动设备上使用。SQLite不仅支持标准的SQL语法，还遵循了数据库的ACID事务。创建数据库Android专门提供了一个SQLiteOpenHelper帮助类让我们能够更加方便地管理数据库，借助这个类就可以非常简单地对数据库进行创建和升级。SQLiteOpenHelper是一个抽象类，
Android异步消息处理机制（二）：从源码的角度彻底理解
iDarren的博客
03-25 508
首先要知道如何创建Handler对象new Thread(new Runnable() { @Override public void run() { Looper.prepare(); handler2 = new Handler(); } }).start(); 在第4行，我们在子线程中先调用一下Looper.pre
Android异步消息处理机制（一）：理解 Looper、Handler、Message三者间关系
iDarren的博客
03-24 424
概述 因为Android UI是线程不安全的，如果在子线程中尝试进行UI操作，程序可能会崩溃。解决方案很简单，即创建一个Message对象，然后借助Handler发送出去，之后在Handler的handleMessage()方法中获得刚才发送的Message对象，然后在这里进行UI操作。 Handler、Looper、Message都是与Android异步消息处理线程相关的概念。三者的关系是：
ijkplayer 自定义协议播放加密内容 Android
juruiyuan111的专栏
08-02 837
想对播放的音视频进行加密，防止资源被盗用，该怎么办呢？这篇文章从自定义协议的角度来提供一中实现思路。在 ijkplayer 的基础上，通过实现自定义协议对文件进行解密。边解边播，以此为基础，还可以实现在线资源边下载边解密边播放。结合 ijkplayer 源码阅读本文效果最佳。
深入理解PHP的$_SESSION机制
2301_76364917的博客
08-02 418
会创建一个唯一的Session ID，并通过HTTP响应头将这个ID保存到客户端的Cookie中。同时，在服务器端也会创建一个以Session ID命名的文件，用于保存该用户的会话信息。本文由ChatMoney团队出品，ChatMoney专注于AI应用落地与变现，我们提供全套、持续更新的AI源码系统与可执行的变现方案，致力于帮助更多人利用AI来变现，欢迎进入。不会创建新的Session ID，而是在服务器上查找与Session ID同名的文件，并应用之前保存的会话信息。：设置缓存中的会话文档过期时间。
【Android】四大组件（Activity、Service、Broadcast Receiver、Content Provider）、结构目录
xzzteach的博客
08-01 574
当 Activity 的启动模式为 singleTask 的时候，每次启动该 Activity 的时候系统会首先在返回栈中检查是否存在该 Activity 的实例，如果发现已经存在则直接使用该实例。假设你在当前的Activity中又要启动同类型的Activity，此时建议将此类型Activity的启动模式指定为SingleTop，能够降低Activity的创建，节省内存!standard 模式是 Activity 的默认启动模式，在不进行显示指定的情况下，所有 Activity 都会自动使用这种启动模式。
android compose设置圆角不起作用
LlanyW的专栏
08-05 105
把圆角放在背景色之前。.clip放在.background前。
[MRCTF2020]Ezpop1
kw741951的博客
08-05 719
/这里urlencode是为了防止 protected 对象对结果造成影响。调用invoke魔术方法需要将对象当做一个函数来使用，这样invoke方法就会自动调用。，然后成功调用invoke魔术方法就可以读出flag。果我们把modifiy对象的var改为。一看base64编码。
第二十一天培训笔记
最新发布
weixin_70756988的博客
08-05 512
查看数据库，查看表，查看表内容，能够正常查看。1）远程登录前提条件是。
安卓碎片Fragment
君子慎独，不欺暗室。卑以自牧，含章可贞。
08-05 598
为了方便Fragment和Activity之间进行交互，FragmentManager提供了一个类似于findViewById()的方法，专门用于从布局文件中获取Fragment的实例。调用FragmentManager的findFragmentById()方法，可以在Activity中得到相应Fragment的实例，然后就能轻松地调用Fragment里的方法了。(4) 向容器内添加或替换Fragment，一般使用replace()方法实现，需要传入容器的id和待添加的Fragment实例。
几种可以帮助Android设备上恢复出厂设置后恢复手机数据解决方案和技术
qq_23996309的博客
08-05 523
由于恢复出厂设置而丢失数据可能是毁灭性的，但幸运的是，有多种方法和解决方案可以帮助您恢复丢失的数据。如果您之前在 Android 设备上启用了 Google 备份和同步功能，则在恢复出厂设置后，您或许能够恢复部分丢失的数据。A5：是的，可以通过直接在Android设备上使用专门的数据恢复应用程序，在没有计算机的情况下恢复出厂设置后恢复手机数据。但是，并非所有应用数据都是可恢复的，尤其是在数据已被覆盖或应用没有适当的备份功能的情况下。A1：是的，可以使用数据恢复软件在恢复出厂设置后恢复数据，而无需备份。
Android平台Java代码规范详解
"Android平台的Java代码规范是用于协调团队开发的重要指导，旨在提升代码的可读性和一致性。本文档详细列举了Java编程在Android环境下的排版、语句结构和表达式处理等方面的规定，有助于避免错误并提高代码质量。" ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值