IDEA 设置文档注释

1、参考资料

1. IDEA类和方法注释模板设置（非常详细）
2. idea注释模版配置（吐血推荐！！！）

2、类文档注释

2.1、设置类文档注释模板

在【File and Code Templates】页面设置类（Class）的文档注释

/**
 *@ClassName ${NAME}
 *@Description  TODO
 *@Author ${USER}
 *@Date ${DATE} ${TIME}
 *@Version 1.0
 */

2.2、使用类文档注释

注意：只有新建类的时候，才能创建类的文档注释哦

3、设置接口文档注释

3.1、设置接口文档注释模板

同样的方法，在【File and Code Templates】页面设置接口（Interface）的文档注释

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 *@InterfaceName ${NAME}
 *@Description  TODO
 *@Author Oneby
 *@Date ${DATE} ${TIME}
 *@Version 1.0
 */
public interface ${NAME} {
}

3.2、使用接口文档注释

注意：只有新建接口的时候，才能创建接口的文档注释哦

4、方法文档注释

4.1、设置方法文档注释模板

1. 在【Live Templates】中新建一个模板

   

2. 默认会新建一个名为 user 的分组（我也懒得改名字了）

   1. Abbreviation：* 表示在方法上输入 *，再敲击 Enter 就能出现方法文档注释
   2. Description：为方法添加文档注释
   3. Template Text：模板内容
   4. Applicable in Java：仅在 Java 文件中生效

   

3. 为模板上的变量添加默认值

   

4. 方法文档注释的模板

   ** 
    * @description: $description$
    $params$
    * @return: $returns$
    * @author Oneby
    * @date: $date$ $time$
    */ 
   

5. params 的 default value：

   groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\n ' : '')};return result", methodParameters())methodParameters()) 
   

4.2、使用方法文档注释

Nice~~~

一. 概述

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

一.给类创建文档注释

第一步

打开idea ==> 点击file ==> 选择Settings (也可以用快捷键 Ctrl + Alt + S)

第二步

点击Editor ==> File and Code Templates ==> 找到Class

第三步

在右边 #parse()下面输入

/**
 *
 *@author Tonny
 *@date ${DATE} ${TIME}
 *@version 2021.2
 */

点击Apply就完成了

• @author为作者名
• @date为编写时间
• @version为你的软件版本号(不是JDK,我的idea是2021.2版本的)

第四步

我们新创建一个类就能看见我们写的文档注释了

二.用快捷键给类创建文档注释

第一步

打开idea ==> 点击file ==> 选择Settings (也可以用快捷键 Ctrl + Alt + S)

第二步

点击Editor ==> Live Templates ==> 点击右边加号选择第二个

(意思是创建一个新的组)

第三步

名字最好是命名为你的名称加Group,我这里命名为TonnyGroup(当然,你要叫其他的也没有问题) ==> 点击OK

第四步

选择你刚刚命名的组,点击右上角＋号选择第一个

第五步

输入以下内容在输入框中:

/**
 * @author Tonny
 * @date $date$ $time$
 * @version 2021.2
 */

在Abbreviation中输入的内容就是你调出这个文档注释的快捷指令(我命名为了*c,你们觉得哪种舒服就怎样来,要记住)

在Description中输入,这个快捷指令的说明

第六步

点击Edit variables ==> 在Default value中分别输入 date() 和 time()

这里输入的date() 和 time() 的作用分别是获取日期和时间,输出的位置就是刚刚我们输入 @date $date$ $time$ 的地方

第七步

我们点击左下角的蓝字 ==> 把Java勾选上(Java下面的东西会自动全部勾选)

第八步

我们在 expand with 中选择Enter ==> 点击Apply就完成配置了

第九步

我们输入我们刚刚设置的快捷指令,在右边可以看到我们设置的说明,回车一下我们就正确的完成了这个配置过程

三.用快捷键给方法创建文档注释

这个配置过程和刚刚的用快捷键给类创建文档注释操作类似

第一步

我们刚刚不是创建了TonnyGroup吗?选择它,点击＋号 ==> 点击第一个

(我这里已经创建好了)

第二步

我这里快捷指令和说明都写好了,你们觉得哪种好写哪种

输入以下内容在方框中

/**
 * @author Tonny
 * @Param $param$
 * @return $return$
 * @date $date$ $time$
 */

第三步

点击Edit variables ==> 在Default value中分别输入以下内容 ==> 我们在 expand with 中选择Enter

第四步

我们点击左下角的蓝字 ==> 把Java勾选上(Java下面的东西会自动全部勾选)

==> 点击Apply就完成配置了

第五步

检查一下配置有没有完成