【问题标题】:JavaDoc giving fully-qualified class name... how to abbreviate?JavaDoc 给出完全限定的类名......如何缩写?
【发布时间】:2013-01-12 23:07:25
【问题描述】:

问题

我正在运行mvn javadoc:javadoc 来生成JavaDoc,我对结果很满意,除了一件事:它为来自第三方库或我们自己的代码库的任何类提供了完全限定的类名。例如,

它为返回这些类之一的方法提供 com.project.beans.BeanAcom.project.beans.BeanB 的返回类型。

它为采用 JSON 对象的方法提供 org.codehaus.jettison.json.JSONObject 的参数类型。 (而它为采用 java.lang.Integer 的方法提供了 Integer 的参数类型。)

问题

为了便于阅读,有没有办法为这些类生成简写名称?即 BeanA、BeanB、JSONObject。

有没有办法在没有任何 XML 配置的情况下做到这一点?

提前致谢:-)

【问题讨论】:

  • 当您在 javadoc 插件配置中没有适当的 <links> 配置部分时,通常会发生这种情况。

标签: java javadoc maven-javadoc-plugin


【解决方案1】:

我相信你想要的是-noqualifier javadoc option,它可以直接通过maven javadoc:javadoc 命令设置。

通常将参数传递给一个 maven 插件,就像使用 -D 的其他 Java 程序一样,在这种情况下它将是 mvn -Dnoqualifier=all javadoc:javadoc,但据我所知,noqualifier 似乎不是设置为插件源中的表达式,所以我真的不知道您是否可以通过命令行传递它。

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

【讨论】:

    猜你喜欢
    • 2019-12-14
    • 2017-06-20
    • 2020-11-12
    • 1970-01-01
    • 1970-01-01
    • 2021-12-23
    • 2011-11-08
    • 1970-01-01
    • 2021-03-25
    相关资源
    最近更新 更多