【JavaDoc】都什么年代了，还在写传统注释（Java新建类自动加注释）

Java新建类自动加注释

写在前面

在网上查了一些自动加注释，基本都是要加上自定义标签，这样的话会让idea识别不出来，每次都需要添加自定义标签，而且idea没法在阅读器模式中识别这些标签，那么使用Javadoc的标签显然会更好。

如何使用

打开设置→编辑器→文件和代码模板（File→settings→Editor→File and Code Templates），找到想要修改的文件。Class就是普通的java文件，Interface就是接口。其他几个类比Class文件即可。
在模板的右边填入：

Class

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
 * $PROJECT_NAME.$NAME
 * 
 * @apiNote     $description
 * @author      $USER
 * @version     $DATE $TIME
 **/
public class ${NAME} {
}

直接覆盖即可，也可以直接将中间注释部分粘贴进去。

参数说明

@apiNote 描写这个类的作用；

@author 作者，如果系统名称不对的话可以把 $USER改成自己的名字；

@version 版本，如果不仅仅要时间的话，可以用逗号隔开；

Interface

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
 * $PROJECT_NAME.$NAME
 * 
 * @implNote    $description
 * @author      $USER
 * @version     $DATE $TIME
 **/
public class ${NAME} {
}

参数说明

@implNote 描写接口实现者该如何实现；

@author 作者，如果系统名称不对的话可以把 $USER改成自己的名字；

@version 版本，如果不仅仅要时间的话，可以用逗号隔开；

方法注释

个人推荐使用/**+enter的方式去生成以后自行补充参数和说明，如果实在想自动生成的话可以参考这篇文章

IDEA类和方法注释模板设置（非常详细）

效果图

显示中文是因为我装了翻译插件，会自动翻译文档。

生成效果

阅读器模式