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

标签 java javadoc maven-javadoc-plugin

问题

我正在运行 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 配置的情况下做到这一点?

提前致谢:-)

最佳答案

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

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

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

关于JavaDoc 提供完全限定的类名...如何缩写?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/14298916/

相关文章:

java - NPE 防守 v try/catch ?

java - Quartz 中每 n 周的工作日 a 和 b 的 x 点执行一次作业

java - 如何让Android studio内嵌JDK使用本地文档路径

Java 9 : How to find every new method added

java - 当构建版本不是-SNAPSHOT 时如何启用 Maven 配置文件?

java GUI布局建议

java - 为什么要编译 Java 正则表达式?

javadoc - 如何为 AEM CQ5.6 配置 javadocs?

maven 3 javadoc 插件不采用 excludepackagename 配置

maven-javadoc-plugin 覆盖中央存储库