版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/ddnosh/article/details/84196490
为了自己和他人阅读代码的方便，请做好注释。
具体可以在AS中自己配制，Settings → Editor → File and Code Templates → Includes → File Header
文件头注释
文件顶部统一添加版权声明，声明的格式如下：
/**
* Copyright (c) 2018 Your Company. All rights reserved.
*/
类注释
/**
* 对类的描述
* @author: 张三
* @e-mail: xxx@xx
* @time: ${date}${time}
* @version: 1.0
*/
方法注释
每一个成员方法（包括自定义成员方法、覆盖方法、属性方法）的方法头都必须做方法头注释。
在方法前一行输入/** + 回车，或者到AS中设置Fix doc comment(Settings → Keymap → Fix doc comment)快捷键，AS会帮我们自动生成模板，我们只需要补全参数即可。
/**
* 对方法的说明
* @param id 查询用ID
* @return User实体类
*/
方法体内代码注释
- 对代码块注释
/***************** 说明 ******************/
- 对单行注释
// 说明
- 对多行注释
/*
* 说明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; // 性别
资源文件注释
<!-- Toast信息 -->
TODO注释
需要实现，但目前还未实现的功能说明。
//TODO 下个版本需要完成二期功能
FIXME注释
功能代码有问题，需要修复的说明。
//FIXME 返回值没有带上单位符号