Android 开发代码规范

一. AndroidStudio开发工具规范

  1. 使用最新的稳定版本.
  2. 统一文件的编码格式为utf-8.
  3. 清除每个类里面的无效的import导包.
  4. 代码样式统一,比如，tab缩进4个空格，或者 tab size等如果没有特殊情况使用默认的配置即可。
  5. 每行字数每行字符数不得超过 160 字符，设置 Editor -> Code Style.
  6. 编辑完 .java、.kt、.xml 等文件后必须格式化.

二. 命名规范

1. 包名

包名全部小写，不允许出现中文、大写字母或者下划线。

2. 类名

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

类描述例如
Activity类模块名 +Activity闪屏页类SplashActivity
Fragment类模块名 +Fragment主页类HomeFragment
Service类模块名 +Service时间服务TimeService
BroadcastReceiver类功能名 +Receiver推送接收JPushReceiver
ContentProvider类功能名 +ProviderShareProvider
自定义 View功能名 + View/ViewGroup(组件名称)ShapeButton
Dialog对话框功能名+DialogImagePickerDialog
Adapter类模块名 +Adapter课程详情适配器LessonDetailAdapter
解析类功能名 +Parser首页解析类HomePosterParser
工具方法类功能名 +Utils或Manager线程池管理类：ThreadPoolManager
日志工具类：LogUtils（Logger也可）
打印工具类：PrinterUtils
数据库类功能名 +DBHelper新闻数据库：NewsDBHelper
自定义的共享基础类Base+ 基础BaseActivity,BaseFragment
抽象类Base/Abstract开头AbstractLogin
异常类Exception结尾LoginException

接口（interface）：命名规则与类一样采用大驼峰命名法。

3. 方法名

方法名都以 lowerCamelCase 风格编写。方法名通常是动词或动词短语。

方法说明
initXX()初始化相关方法，使用 init 为前缀标识，如初始化布局initView()
isXX(),checkXX()方法返回值为 boolean 型的请使用 is/check 为前缀标识
getXX()返回某个值的方法，使用 get 为前缀标识
setXX()设置某个属性值
handleXX(),processXX()对数据进行处理的方法
displayXX(),showXX()弹出提示框和提示信息，使用 display/show 为前缀标识
updateXX()更新数据
saveXX(),insertXX()保存或插入数据
resetXX()重置数据
clearXX()清除数据
removeXX(),deleteXX()移除数据或者视图等，如removeView()
drawXX()绘制数据或效果相关的，使用 draw 前缀标识

4. 变量命名

这里的变量为广义的变量，包括了常量、局部变量、全局变量等，它们的基础规则是：

  • 类型需要是名词 / 名词短语；
  • 采用 lowerCamelCase 风格；

在具体的变量命名时，会根据该变量的类型不同而附加额外的命名规则：

类型说明例如
常量大写 & 下划线隔开，Kotlin 一定要 const valconst val TYPE_NORMAL = 1 static final TYPE_NORMAL = 1
临时变量名整型：i、j、k、m、n，字符型一般用c、d、efor(int i = 0;i < len; i++)
其他变量lowerCamelCase风格即可，私有变量也不要使用m开头private int tmp;
Kotlin只读变量使用val，可变变量使用var，尽可能使用valvar tmp = 0 val defaultIndex = 0

5. 资源文件

资源文件命名为全部小写，采用下划线命名法。

动画资源文件（anim/ 和 animator/）

安卓主要包含属性动画和视图动画，其视图动画包括补间动画和逐帧动画。属性动画文件需要放在 res/animator/ 目录下，视图动画文件需放在 res/anim/ 目录下。命名规则：{模块名_}逻辑名称。

说明：{} 中的内容为可选，逻辑名称 可由多个单词加下划线组成。例如：refresh_progress.xml、market_cart_add.xml、market_cart_remove.xml。

如果是普通的补间动画或者属性动画，可采用：动画类型_方向 的命名方式。

例如：

名称说明
fade_in淡入
fade_out淡出
push_down_in从下方推入
push_down_out从下方推出
push_left推向左方
slide_in_from_top从头部滑动进入
zoom_enter变形进入
slide_in滑动进入
shrink_to_middle中间缩小

图片资源文件（drawable/ 和 mipmap/）

res/drawable/ 目录下放的是位图文件（.png、.9.png、.jpg、.gif）或编译为可绘制对象资源子类型的 XML 文件，而 res/mipmap/ 目录下放的是不同密度的启动图标，所以 res/mipmap/ 只用于存放启动图标，其余图片资源文件都应该放到 res/drawable/ 目录下。

命名规则：类型{_模块名}_逻辑名称、类型{_模块名}_颜色。

说明：{} 中的内容为可选；类型 可以是可绘制对象资源类型，也可以是控件类型最后可加后缀 _small 表示小图，_big 表示大图。

例如：

名称说明
btn_main_about.png主页关于按键类型_模块名_逻辑名称
btn_back.png返回按键类型_逻辑名称
divider_maket_white.png商城白色分割线类型_模块名_颜色
ic_edit.png编辑图标类型_逻辑名称
bg_main.png主页背景类型_逻辑名称
btn_red.png红色按键类型_颜色
btn_red_big.png红色大按键类型_颜色
ic_avatar_small.png小头像图标类型_逻辑名称
bg_input.png输入框背景类型_逻辑名称
divider_white.png白色分割线类型_颜色
bg_main_head.png主页头部背景类型_模块名_逻辑名称
def_search_cell.png搜索页面默认单元图片类型_模块名_逻辑名称
ic_more_help.png更多帮助图标类型_逻辑名称
divider_list_line.png列表分割线类型_逻辑名称
sel_search_ok.xml搜索界面确认选择器类型_模块名_逻辑名称
shape_music_ring.xml音乐界面环形形状类型_模块名_逻辑名称

如果有多种形态，如按钮选择器：sel_btn_xx.xml，采用如下命名：

名称说明
sel_btn_xx作用在btn_xx上的selector
btn_xx_normal默认状态效果
btn_xx_pressedstate_pressed点击效果
btn_xx_focusedstate_focused聚焦效果
btn_xx_disabledstate_enabled不可用效果
btn_xx_checkedstate_checked选中效果
btn_xx_selectedstate_selected选中效果
btn_xx_hoveredstate_hovered悬停效果
btn_xx_checkablestate_checkable可选效果
btn_xx_activatedstate_activated激活效果
btn_xx_window_focusedstate_window_focused窗口聚焦效果

注意：使用 Android Studio 的插件 SelectorChapek 可以快速生成 selector，前提是命名要规范。

布局资源文件（layout/）

命名规则：类型_模块名、{模块名_}类型_逻辑名称。(也采用 PBF，方便查看，尤其在大项目中)

说明：{} 中的内容为可选。

例如：

类型名称说明
Activitymain_activity.xml主窗体模块名_类型
Fragmentmusic_fragment.xml音乐片段模块名_类型
Dialogloading_dialog.xml加载对话框逻辑名称_类型
PopupWindowinfo_ppw.xml信息弹窗（PopupWindow）逻辑名称_类型
adapter的列表项main_song_item.xml主页歌曲列表项模块名_类型_逻辑名称

布局资源 id 命名

命名规则：view 缩写{_模块名}_逻辑名，例如： btn_main_search、btn_back。
注意:使用databinding,viewbinding 直接获取布局文件控件的时候，id 命名采用驼峰样式。

菜单资源文件（menu/）

菜单相关的资源文件应放在该目录下。命名规则：{模块名_}逻辑名称

说明：{} 中的内容为可选。

字符串资源文件strings

<string> 的 name 命名使用下划线命名法，采用以下规则：{模块名_}逻辑名称，这样方便同一个界面的所有 string 都放到一起，方便查找。

名称说明
main_menu_about主菜单按键文字
friend_title好友模块标题栏
friend_dialog_del好友删除提示
login_check_email登录验证
dialog_title弹出框标题
button_ok确认键
loading加载文字

样式资源文件tyles

<style> 的 name 命名使用大驼峰命名法，几乎每个项目都需要适当的使用 styles.xml 文件，因为对于一个视图来说，有一个重复的外观是很常见的，将所有的外观细节属性（colors、padding、font）放在 styles.xml 文件中。在应用中对于大多数文本内容，最起码你应该有一个通用的 styles.xml 文件，例如：

<style name="ContentText">
    <item name="android:textSize">@dimen/font_normal</item>
    <item name="android:textColor">@color/basic_black</item>
</style>

应用到 TextView 中：

<TextView
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="@string/price"
    style="@style/ContentText"/>

或许你需要为按钮控件做同样的事情，将一组相关的和重复 android:xxxx 的属性放到一个通用的

颜色资源文件（color/）

color/ 是专门用于存放颜色相关资源的文件夹。命名规则：类型{_模块名}_逻辑名称。

说明：{} 中的内容为可选。例如：sel_btn_font.xml。

<color> 的 name 命名使用下划线命名法，在你的 colors.xml 文件中应该只是映射颜色的名称一个 ARGB 值，而没有其它的。不要使用它为不同的按钮来定义 ARGB 值。

<?xml version="1.0" encoding="utf-8"?> 
  <!-- grayscale -->
  <color name="white"     >#FFFFFF</color>
  <color name="gray_light">#DBDBDB</color>
  <color name="gray"      >#939393</color>
  <color name="gray_dark" >#5F5F5F</color>
  <color name="black"     >#323232</color>

  <!-- basic colors -->
  <color name="green">#27D34D</color>
  <color name="blue">#2A91BD</color>
  <color name="orange">#FF9D2F</color>
  <color name="red">#FF432F</color>

向应用设计者那里要这个调色板，名称不需要跟 "green"、"blue" 等等相同。"brand_primary"、"brand_secondary"、"brand_negative" 这样的名字也是完全可以接受的。像这样规范的颜色很容易修改或重构，会使应用一共使用了多少种不同的颜色变得非常清晰。通常一个具有审美价值的 UI 来说，减少使用颜色的种类是非常重要的。

注意：如果某些颜色和主题有关，那就单独写一个 colors_theme.xml。

注释规范

4.1 类注释

每个类完成后应该有作者姓名和联系方式的注释，对自己的代码负责。

/**
 * @Author ：xxx
 * @Date   ：xxxx/xx/xx
 * @Email  ：xxxxxx@xxx.com
 * @Desc   ：欢迎界面
 */
public class WelcomeActivity {
    ...
}

具体可以在 AS 中自己配制，进入 Settings -> Editor -> File and Code Templates -> Includes -> File Header，输入

/**
 * @Author : ${USER}
 * @Date   : ${YEAR}/${MONTH}/${DAY}
 * @Email  : xxx@xx
 * @Desc   :
 */

这样便可在每次新建类的时候自动加上该头注释。

4.2 方法注释

每一个成员方法（包括自定义成员方法、覆盖方法、属性方法）的方法头都必须做方法头注释，在方法前一行输入 /** + 回车 或者设置 Fix doc comment（Settings -> Keymap -> Fix doc comment）快捷键，AS 便会帮你生成模板，我们只需要补全参数即可。

4.3 块注释

块注释与其周围的代码在同一缩进级别。它们可以是 /* ... */ 风格，也可以是 // ... 风格（ // 后最好带一个空格 ）。对于多行的 /* ... */ 注释，后续行必须从 * 开始， 并且与前一行的 * 对齐。

4.4 全局变量的注释

全局变量的注释样式如下（注意注释之间有空格）：

/**
 * The next available accessibility id.
 */
private static int nextAccessibilityViewId;
/**
 * The animation currently associated with this view.
 */
protected Animation currentAnimation = null;

4.5 其他一些注释

AS 已帮你集成了一些注释模板，我们只需要直接使用即可，在代码中输入 TODO、FIXME 等这些注释模板，回车后便会出现如下注释。

// TODO: 17/3/14 需要实现，但目前还未实现的功能的说明
// FIXME: 17/3/14 需要修正，甚至代码是错误的，不能工作，需要修复的说明

4.5 注释必须遵守的规范

  • 提测的代码不应该有 TODO 这样的注释(特殊情况除外)

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/53307.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

flask处理文件上传

flask处理文件上传

flask处理文件上传 在Flask框架中&#xff0c;你可以使用request.files对象来处理文件上传。以下是一个简单的文件上传的示例&#xff1a; from flask import Flask, request from werkzeug.utils import secure_filename import osapp Flask(__name__)# 定义文件上传的路径…
阅读更多...
Web3将自己写在合约中的代币添加到MetaMask中管理

Web3将自己写在合约中的代币添加到MetaMask中管理

上文 Web3带着大家根据ERC-20文档编写自己的第一个代币solidity智能合约 带着大家在智能合约中创建了一个自己的代币系统 我们可以在MetaMask中去导入 ganache环境下模拟出来的第一和第二个账号 我们这里 可以看到他们的 ETH 但看不到自己的代币符号 没关系 我们点击这下面的…
阅读更多...
cicd实验

cicd实验

系列文章目录 文章目录 系列文章目录一、1.2. 二、安装并使用1.安装gitlab2.//Jenkins安装3. 总结 一、 1. 2. 二、安装并使用 需要三台服务器一台安装gitlab 192.168.169.10 第二台负责 安装jenkins 192.168.169.20 第三台是负责业务 192.168.169.30 1.安装gitlab yum in…
阅读更多...
【前端知识】React 基础巩固(三十九)——React-Router的基本使用

【前端知识】React 基础巩固(三十九)——React-Router的基本使用

React 基础巩固(三十九)——React-Router的基本使用 一、Router的基本使用 Router中包含了对路径改变的监听&#xff0c;并且会将相应的路径传递给子组件。 Router包括两个API&#xff1a; BrowserRouter使用history模式 HashRouter使用hash模式&#xff08;路径后面带有#号…
阅读更多...
Linux进程概念（一）

Linux进程概念（一）

文章目录 Linux进程概念查看进程杀死进程进程标识符 手动创建进程的方式fork函数创建进程 进程状态运行态阻塞态和挂起 Linux进程概念 前文我们了解了&#xff0c;进程的基本概念&#xff0c;在课本上被描述为&#xff0c;正在执行的程序&#xff0c;在linux内核上&#xff0c…
阅读更多...
第一百一十六天学习记录：C++提高：STL-string（黑马教学视频）

第一百一十六天学习记录：C++提高：STL-string（黑马教学视频）

string基本概念 string是C风格的字符串&#xff0c;而string本质上是一个类 string和char区别 1、char是一个指针 2、string是一个类&#xff0c;类内部封装了char*&#xff0c;管理这个字符串&#xff0c;是一个char型的容器。 特点&#xff1a; string类内部封装了很多成员方…
阅读更多...
C++——STL容器之list链表的讲解

C++——STL容器之list链表的讲解

目录 一.list的介绍 二.list类成员函数的讲解 2.2迭代器 三.添加删除数据&#xff1a; 3.1添加&#xff1a; 3.2删除数据 四.排序及去重函数&#xff1a; 错误案例如下&#xff1a; 方法如下&#xff1a; 一.list的介绍 list列表是序列容器&#xff0c;允许在序列内的任何…
阅读更多...
Git学习

Git学习

一、Git工作流程 二、Git学习 1.获取本地仓库 要使用Git对我们的代码进行版本控制&#xff0c;首先需要获得本地仓库 在电脑的任意位置创建一个空目录(例如test)作为我们的本地Git仓库进入这个目录中&#xff0c;点击右键打开Git bash窗口执行命令git init如果创建成功后可在…
阅读更多...
点云处理——terrasolid教程

点云处理——terrasolid教程

加载terrasolid软件模块 3、通过microstation的utilities->mdl applications加载terrasolid四个模块,加载成功后将显示tscan和tphoto的主窗口&#xff0c;以及四个模块的主工具箱。 浏览点云 4、显示点云坐标信息(类&#xff0c; 航带号&#xff0c;GPS信息&#xff0c;东…
阅读更多...
文心一言 VS 讯飞星火 VS chatgpt （67）-- 算法导论6.5 6题

文心一言 VS 讯飞星火 VS chatgpt （67）-- 算法导论6.5 6题

文心一言 VS 讯飞星火 VS chatgpt &#xff08;67&#xff09;-- 算法导论6.5 6题 六、在 HEAP-INCREASE-KEY 的第 5 行的交换操作中&#xff0c;一般需要通过三次赋值来完成。想一想如何利用INSERTION-SORT 内循环部分的思想&#xff0c;只用一次赋值就完成这一交换操作? 文…
阅读更多...
【Django+Vue】英文成绩管理平台--20230727

【Django+Vue】英文成绩管理平台--20230727

能够满足大部分核心需求&#xff08;标绿&#xff09;&#xff1a;报表部分应该比较难。 项目地址 前端编译 https://gitlab.com/m7840/toeic_vue_dist Vue源码 https://gitlab.com/m7840/toeic_vue Django源码 https://gitlab.com/m7840/toeic_python 项目架构 流程 …
阅读更多...
嵌入式面试常见题目收藏(超总结）

嵌入式面试常见题目收藏(超总结）

​ 这篇文章来自很多博客主和其他网站的作者&#xff0c;如有侵权&#xff0c;联系必删 文章出处标注&#xff1a; https://blog.csdn.net/qq_44330858/article/details/128947083 ***如需PDF或者原稿可私信 *** ***如需PDF或者原稿可私信 *** ***如需PDF或者原稿可私信 *** 1.…
阅读更多...
16位S912ZVML32F3MKH、S912ZVML31F1WKF、S912ZVML31F1MKH混合信号MCU，适用于汽车和工业电机控制应用。

16位S912ZVML32F3MKH、S912ZVML31F1WKF、S912ZVML31F1MKH混合信号MCU，适用于汽车和工业电机控制应用。

S12 MagniV微控制器是易于使用且高度集成的混合信号MCU&#xff0c;非常适合用于汽车和工业应用。S12 MagniV MCU提供单芯片解决方案&#xff0c;是基于成熟的S12技术的完整系统级封装 (SiP) 解决方案&#xff0c;在整个产品组合内软件和工具都兼容。 S12 MagniV系统级封装 (S…
阅读更多...
EP4CE6E22C8N Error: Can‘t recognize silicon ID for device 1

EP4CE6E22C8N Error: Can‘t recognize silicon ID for device 1

经过各种排查&#xff0c;发现是AS配置不对&#xff0c;仅供参考 工程 参考某处的工程画板配置的FPGA板子&#xff0c;用于学习入门FPGA。 烧录sof文件是正常的&#xff0c;并能正常运行。 但是烧录jic是failed&#xff0c;查看报错为&#xff1a;Error: Can’t recognize si…
阅读更多...
【Maven】让maven更高效，优化maven构建项目速度

【Maven】让maven更高效，优化maven构建项目速度

打开idea的setting&#xff0c;找到maven&#xff0c;设置它多线程数&#xff0c;重启后即可&#xff01; 我这里是8&#xff0c;你们可以随便设置。 如下图&#xff1a;
阅读更多...
【高级数据结构】树状数组

【高级数据结构】树状数组

目录 树状数组1 &#xff08;单点修改&#xff0c;区间查询&#xff09; 树状数组1 &#xff08;单点修改&#xff0c;区间查询&#xff09; 洛谷&#xff1a;树状数组1https://www.luogu.com.cn/problem/P3374 题目描述 如题&#xff0c;已知一个数列&#xff0c;你需要进行…
阅读更多...
Vulnhub: shenron: 3靶机

Vulnhub: shenron: 3靶机

kali&#xff1a;192.168.111.111 靶机&#xff1a;192.168.111.171 信息收集 端口扫描 nmap -A -sC -v -sV -T5 -p- --scripthttp-enum 192.168.111.171 修改hosts后访问目标80端口&#xff0c;发现是wordpress wpscan收集目标用户&#xff0c;爆破出密码&#xff1a;ilov…
阅读更多...
前后端分离开发流程

前后端分离开发流程

1、介绍 在前后端分离开发中&#xff0c;前端负责用户界面和交互逻辑的实现&#xff0c;后端则处理业务逻辑和数据持久化。这种开发模式的优势在于前后端可以独立进行开发&#xff0c;提高了开发效率&#xff0c;并且使得前后端可以采用不同的技术栈来实现各自的功能。 2、开…
阅读更多...
LabVIEW FPGA开发实时滑动摩擦系统

LabVIEW FPGA开发实时滑动摩擦系统

LabVIEW FPGA开发实时滑动摩擦系统 由于非线性摩擦效应的建模和补偿的固有困难&#xff0c;摩擦系统的运动控制已被广泛研究。最近&#xff0c;人们更加关注滑动动力学和滑动定位&#xff0c;作为传统机器人定位的低成本和更灵活的驱动替代方案。摩擦控制器设计和适当选择基础…
阅读更多...
NodeJs后端项目使用docker打包部署

NodeJs后端项目使用docker打包部署

docker安装看之前的文章 默认已经安装好docker并且配置没有问题 拉取项目 https://gitee.com/coder-msc/docker-node 本地跑一个看看 pnpm install pnpm start 本地访问 http://localhost:1301/getname?name%E5%93%88%E5%88%A9%E6%B3%A2%E7%89%B9项目整个上传服务器 查看…
阅读更多...
最新文章

Copyright @ 2022~2023