JavaDoc提供了完全限定的类名...如何缩写？

Question

6

问题

我正在运行 mvn javadoc:javadoc 来生成 JavaDoc，我对结果感到满意，除了一个问题：它会为来自第三方库或我们自己代码库的任何类提供完全限定的类名。例如，

对于返回这些类之一的方法，它会给出com.project.beans.BeanA，com.project.beans.BeanB 的返回类型。

对于接受 JSON 对象的方法，它会给出参数类型org.codehaus.jettison.json.JSONObject。（而对于接受 java.lang.Integer 的方法，它会给出参数类型 Integer。）

问题

有没有办法生成这些类的简写名称，以便更易读？即 BeanA、BeanB、JSONObject。

而且有没有一种不需要任何 XML 配置的方法来做到这一点？

先谢谢了 :-)

- ktm5124

1

通常情况下，这种情况发生在javadoc插件配置中没有适当的<links>配置部分。 - fge

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Alex · Accepted Answer

我认为您想要的是 -noqualifier javadoc选项，可以直接从maven javadoc:javadoc命令设置。

通常，要将参数传递给Maven插件，只需像其他Java程序一样使用-D即可，在这种情况下，它将是mvn -Dnoqualifier=all javadoc:javadoc，但据我所知，noqualifier似乎没有在插件源中设置为表达式，因此我不知道是否可以通过命令行传递它。

如果不起作用，您可以修改您的pom.xml并将<noqualifier>all</noqualifier>添加到javadoc插件的配置中。或者，您可以在pom中创建一个属性，该属性将被赋予<noqualifier>标记的值，但这次属性可以使用命令行覆盖。