在Java程序中Javadoc注释很重要,但是很多时候注释被漏掉,看看项目中的代码就会知道。如果你结对编程的话,你的伙伴一定会说,“哥们,这儿注释丢掉啦,那个函数的Javadoc注释写的不正确!”。项目中有很多的开发人员,水平和习惯都不太一样,但是对程序中javadoc注释来说,这是不能变化的,要规范起来。如何让每一个人都能养成这样的习惯呢?下面我们就IntelliJ IDEA使用向大家介绍一下。
IDEA默认对Javadoc的支持非常不错,但是这里我们要引入一个插件,那就是JavaDoc Sync Plugin,这两者的结合将非常完美:JavaDoc Sync Plugin会提示你添加javadoc注释及注释同步,而IDEA本身会校验javadoc语法,这样我们的工作就会简单很多。
首先打开Plugin Manager下载并安装JavaDoc Sync Plugin,重启IDEA后在设置面板中选择“Errors”选项,在“Errors”对话框中的文本过滤栏输入javadoc,如下图。这时就会出现和javadoc相关的设置选项:
|