Question

如何处理好Javadoc注释

Answer 1

在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相关的设置选项 这里我们想对这些设置项进行说明：

　　Declaration has javadoc problem：这个设置项主要是校验javadoc的语法错误，如不必要的javadoc注释，必需的tag丢失等等。这个设置项有很多的参数设定，你可以参考一下；
　　Inconsistent Javadoc主要检测javadoc注释冲突，如接口和实行类的javadoc不一致；
　　Missing Class Javadoc delcaration等提示你应该添加注释。
　　Severity最右边的小按钮可以设置错误级别显示效果。
　　有了这些配置，相信你不在会忘记添加javadoc注释啦，因为IDEA会实时地给你指出来（高亮、背景等），这是IDEA的代码审查特性。IDEA同时提供了快速添加和纠错注释功能，只需一个键盘操作，就可以完成注释添加、同步和纠错。
　　
　　
　　总结：通过以上设置，相信每一个人都会养成编写Javadoc的好习惯，格式统一。如在版本控制系统管理下，java类的注释需要@author和@version tag，这样每个人都会加上，对管理代码有很大的帮助。IDEA同时允许你给不同的错误级别设置不同的显示效果，这样你文档中各种问题进行标识，方便管理。