Android开发规范：注释

1. 示例

/**

• 对类的描述

• @author: 张三

• @e-mail: xxx@xx

• @time: $date${time}

• @version: 1.0

*/

2. 设置

方法注释

---

每一个成员方法（包括自定义成员方法、覆盖方法、属性方法）的方法头都必须做方法头注释。

在方法前一行输入**/**** + 回车，或者到AS中设置Fix doc comment(Settings → Keymap → Fix doc comment)快捷键，AS会帮我们自动生成模板，我们只需要补全参数即可。

/**

• 对方法的说明

• @param id 查询用ID

• @return User实体类

*/

通用注释

---

对于注释，我们还可以设定注释模板，然后通过快捷输入的方式自动帮我们生成设定的注释内容。

这样可以在代码的任何地方快捷生成注释，提升编码效率。

File → Settings → Editor → Live Templates，

新建一个MyComment的Group，然后建一个叫cmt的缩写，输入模板内容。

这样我们在代码里面输入cmt然后敲回车，就会自动帮我们生成模板内容。

方法体内代码注释

---

1. 对代码块注释

/***************** 说明 ******************/

2. 对单行注释

// 说明

3. 对多行注释

/*

• 说明1

• 说明2

*/

常量变量的注释

---

下面几种情况下的常量和变量，都要添加注释说明，优先采用右侧//来注释，若注释说明太长则在上方添加注释。

接口中定义的所有常量

公有类的公有常量

枚举类定义的所有枚举常量

实体类的所有属性变量

public static final int TYPE_DOG = 1; // 狗

public static final int TYPE_CAT = 2; // 猫

public static final int TYPE_PIG = 3; // 猪

private int id; // id

private String name; // 名称

private String sex; // 性别

资源文件注释

---

TODO注释

---

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则近万的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）

最后

其实Android开发的知识点就那么多，面试问来问去还是那么点东西。所以面试没有其他的诀窍，只看你对这些知识点准备的充分程度。so，出去面试时先看看自己复习到了哪个阶段就好。

下面分享的腾讯、头条、阿里、美团、字节跳动等公司2019-2021年的高频面试题全套解析，博主还把这些技术点整理成了视频和PDF（实际上比预期多花了不少精力），包含知识脉络 + 诸多细节，由于篇幅有限，下面只是以图片的形式给大家展示一部分。

知识不体系？这里还有整理出来的Android进阶学习的思维脑图，给大家参考一个方向。

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

CLhEBU-1712717126016)]

知识不体系？这里还有整理出来的Android进阶学习的思维脑图，给大家参考一个方向。

[外链图片转存中…(img-Q1vyB0O2-1712717126016)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！