idea是一个神奇的东西,也有很多插件很多,近期一直比较执着于快速定义java注释相关的插件。
那么要来说一说JavaDoc Sync Plugin这个插件了,在插件仓库里面找javadoc相关的插件的时候,无意中发现的,开始以为纯粹是用来生成类或者方法注释的,仔细看了下介绍,才知道主要目的是校验注释的正确性的,其实就是变相帮你生成注释。
网上关于这个插件的介绍不多,大部分写的不太清楚,所以我想要写一个看的懂的~
下面的截图是idea 2017的截图,要开启这个插件,请打开idea的设置(默认快捷键crtl + alt + s),在搜索框中输入JavaDoc Issues,就会看到(如图一)中的样子了,然后选择JavaDocSyncIssues,勾上后面的选项即可。
开启这个设置之后,将光标移至方法名称所在的行后,即会提示需要生成javadoc(如图二)
不同的注释的模板设置,可以参考(如图三),如果idea中只安装了一个插件的朋友,可能不会有Other Settings这个选项,直接进入JavaDoc Sync Settings这个菜单即可。模板中使用了一些变量,语法可以参考idea官方的文档,本文中不做特别介绍
图一
图二
图三
参考链接:idea 插件官方说明
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。