Idea配置方法自动注释

2023.02.27	添加类生成模板
2022.10.26	建议使用官方提供的标签@since和@author分别来表示类文件的创建时间和作者信息，描述信息直接写在双*号后面，自定义的标签（例如@Author，Java本身自带@author）在生成Java Doc的时候是识别不了的。

前言

Idea本身有一套自己的方法注释，不过不够全面，大家可以在方法前使用”/**"加回车查看效果。本文使用Idea 2021.2(Community Edition)进行配置。

步骤

1） 创建Template Group和LiveTemplate

在该模板组下创建一个Live Template效果如下图所示：

2）设置缩写快捷键

框2缩写快捷符号使用“”，我在此之前尝试用过“/**"但是会有问题，然后设置缩写模板如代码1所示，配合Tab键使用。注意模板的格式效果要如下图的框3所示，缩进也要一样。@Description是自定义的标签，可以任意定义但是在生成Java Doc的时候，JavaDoc工具是不会识别这些自定义的标签的，JavaDoc有着自己的一套元标签。双$符号包裹的是自定义的内容，可以选择映射Idea提供的系统函数或者脚本，这样就可以动态生成内容。

*
 *@Description:
 *@Param: $params$
 *@Return: $return$
 *@DateTime: $time$ $Date$
 */

3）对步骤2定义的变量选择函数
上面已经自定义过一些变量（双$包裹的）了，下面要自定义变量选择合适的系统函数来动态成数据，选择上图的框4，进行变量的添加。

4）应用到和Java有关的文件
点击框5将模板应用到和Java有关的文件上。

5）测试

创建方法，在上面输入“/**”然后按Tab，记住不是回车，效果如图所示。

Tips

1）可以根据需要生成类注释，在右边填写模板即可。
这样在创建新类时就可以使用这个模板了，但是我实测时不大好用，Idea会要求你手动添加参数信息，不如创建类后，在类上方使用快捷键生成注释

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @author Caolele 
 * @since ${Date}
 */
public class ${NAME} {
}

2）快捷生成代码
常用的“sout”就是在这里配置的，可以配置自己常用的模板。