关于如何关闭Java 8中的JavaDoc lint功能,有很多信息。信不信由你,今天我决定使用此功能并修复JavaDocs。但是,在其标准配置中,它抱怨所有可能丢失的@param
和@return
。从Java 8 Javadoc技术说明的JavaDoc文档中可以看到,我的选择是-Xdoclint:all,-missing
。这应该包括所有检查,但不要抱怨缺少文档机会。Maven配置如下所示:
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.4</version>
<configuration>
<additionalparam>-Xdoclint:all,-missing</additionalparam>
<aggregate>false</aggregate>
</configuration>
<reportSets>
<reportSet>
<id>default</id>
<reports>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
但是,当mvn site
我运行时出现错误:
[ERROR] Exit code: 1 - javadoc: error - invalid flag: -missing
我怀疑maven中的参数处理是问题,但是,引用无济于事。
任何想法如何使用此?还有其他合理的方式来检查JavaDoc的良好做法吗?
正确的语法是:
-Xdoclint:all -Xdoclint:-missing
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句