Android开发规范：注释(4)

文件顶部统一添加版权声明，声明的格式如下：

1. 示例

/**

• Copyright © 2018 Your Company. All rights reserved.

*/

2. 设置

路径：File → Settings → Editor → File and Code Templates → Includes → File Header

然后在java文件中将这个文件包含进去，这样我们在新建java文件的时候，这个文件头注释也会自动生成。

类注释

---

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; // 猪

最后

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

下图是我进阶学习所积累的历年腾讯、头条、阿里、美团、字节跳动等公司2019-2021年的高频面试题，博主还把这些技术点整理成了视频和PDF（实际上比预期多花了不少精力），包含知识脉络 + 诸多细节

整理不易，望各位看官老爷点个关注转发，谢谢！祝大家都能得到自己心仪工作。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！
视频和PDF（实际上比预期多花了不少精力），包含知识脉络 + 诸多细节

[外链图片转存中…(img-WTaLaId4-1714797636514)]

整理不易，望各位看官老爷点个关注转发，谢谢！祝大家都能得到自己心仪工作。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！