文档注释是功能级注释，只说明三个地方:

类
常量
方法

文档注释可以被java提供的命令javadoc导出成一个文档。

在类上使用文档注释说明当前类的设计意图以及解决的问题。

idea开发环境配置 
一、类注释
File->setting 
Setting->File and Code Templates
我的文档注释模板：
/**
 * @author: ${USER}
 * @date: ${DATE} ${TIME}
 * @description:
 */
附：我的clion文档注释模板
/***********************************************************                                          *
* Time: ${DATE}                                           
* Author: $USER_NAME                                          
***********************************************************/
二、方法注释
IDEA还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，使用Eclipse时我们生成注释的习惯是
/**+Enter，这里我们也按照这种习惯来设置IDEA的方法注释
1、File-->Settings-->Editor-->Live Templates
（1）新建组：命名为userDefine
（2）新建模板：命名为*
因为IDEA生成注释的默认方式是：/*+模板名+快捷键（比如若设置模板名为add快捷键用Tab，则生成方式为
/*add+Tab），如果不采用这样的生成方式IDEA中没有内容的方法将不可用，例如获取方法参数的methodParameters(）、获取方法返回值的methodReturnType(）
（3）设置生成注释的快捷键
（4）设置模板：模板内容如下
注意第一行，只有一个而不是/
在设置参数名时必须用参数名的方式，否则第五步中读取不到你设置的参数名
*
 $param$
 $return$
 * @author: $user$
 * @date: $date$ $time$
 * @description:
 */
如果使用/生成的模板注释将会是如下效果：所以我们要去掉最前面的/
5）设置模板的应用场景
点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere-->Java即可
（如果曾经修改过，则显示为change而不是define）
（6）设置参数的获取方式
选择右侧的Edit variables按钮
PS:第五步和第六步顺序不可颠倒，否则第六步将获取不到方法
选择每个参数对应的获取方法（在下拉选择框中选择即可）
其中params变量的内容一定要放在Default value中！！！内容为：
groovyScript("if("${_1}".length() == 2) {return '';} else {def result=''; def params="${_1}".replaceAll('[[|]|s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ': '}else{result+='n' + ' * @param ' + params[i] + ': '}}; return result;}", methodParameters());
其中return变量的内容也一定要放在Default value中！！！内容为：
groovyScript("def returnType = "${_1}"; def result = '* @return: ' + returnType; return result;", methodReturnType());

单行注释、多行注释与文档注释
单行注释
多行注释
文档注释
==多行注释与文档注释的区别==

单行注释
//注释内容
多行注释
/*

int c = 10;

int x = 5;

*/
文档注释
/**

注释内容

注释内容

*/
多行注释与文档注释的区别
文档注释的内容可以生产一个开发者文档。
使用javadoc开发工具即可生成一个开发者文档。

javadoc工具的使用格式：

javadoc -d 存放文档的路径		java的源文件
使用javadoc工具注意事项：

1.如果一个类需要使用javadoc工具生成一个软件的开发者文档，那么该类必须使用public修饰。

2.文档注释的内容一般都是位于类或者方法的上面。
写注释的规范：一般单行注释是位于代码的右侧，多行注释与文档注释一般是写在类或者方法上面的。

链接：iFat-文档注释与多行注释的区别

文档注释快捷键

shift+alt+j

自定义文档注释

打开Eclipse--Window--Perference--Java--Code Style--Code Templates--Comments--Type--Edit



比如：

/**
 * @author: ${user}
 * @Description:
 * @Time:${date} ${time}  
 * ${tags}
 */