Java文档注释 - IDEA设置

一. 概述

Java支持三种注释。前两种分别是 单行注释 // 和 多行注释 /* */ ，第三种是 文档注释 /** */。

在IDEA中，文档注释可以对类、接口、方法、属性等进行描述，提高阅读效率。

文档注释只能写在类、接口、方法、属性等前面，否则无效。

二. 类注释

1. File -> Settings

2. Editor -> File and Code Templates -> Includes -> File Header

右侧写文档注释模板

3. 模板如下，设置保存后，创建类时，自动生成。

/**
 * @author: ${USER}
 * @date: ${DATE} ${TIME}
 * @description:
 */

三、方法注释

1. Editor -> Live Templates ->   +   -> Template Group

2. 填写模板名字

3. 选中"之前创建的模板" -> Live Template

4. 设置模板生成快捷键

1： 模板名，2：快捷键

1 和 2 设置后，生成快捷键为:  / + 模板名 + 快捷键

5. 模板如下

**
 $param$
 $return$
 * @author: $user$
 * @date: $date$ $time$
 * @description:
 */

6. 设置模板应用场景 Define

(如果曾经修改过，则显示为change而不是define)

7. Everywhere -> Java

8. 设置参数的获取方式，Edit variables

9. 如图填写 (Expression下拉框选中)

param -> 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());

全部完成之后，创建方法后，使用快捷键进行生成。

参考自https://zhuanlan.zhihu.com/p/130419084