java - 如何阻止 Javadoc 使用完全限定名称？

Question

我正在使用 Javadoc 工具来记录一些代码，结果使用系统类的完全限定名称，例如 java.lang.String。有没有办法专门针对 java.* 和 javax.* 层次结构中的类来阻止这种情况？

例如，这样的方法定义:

    * @param field String to write.
    * @throws IOException If the underlying stream throws an exception.
    */
   public void writeField( String field ) throws IOException {
      // etc.

产生如下 Javadoc 输出:

writeField

public void writeField​(java.lang.String field) throws java.io.IOException

    ...etc.

Parameters:
    field - String to write.
Throws:
    java.io.IOException - If the underlying stream throws an exception.

我希望对 java.lang.String 的引用只是 String，对 java.io.IOException 的引用同样只是 IOException。

有什么想法吗？

<小时/>

编辑并更新 re.下面接受的答案:

在 NetBeans 10 中，我解决此问题的方法是转到“项目” View ，然后切换到"file" View 。然后在项目文件中，找到 nbproject/project.properties 并打开该文件(右键单击，选择“打开”)。

在属性 View 中，向左向下滚动，直到看到 javadoc.additionalparam。然后将以下内容添加到该属性的右侧(在我的情况下，其值为空)-link https://docs.oracle.com/en/java/javase/11/docs/api/

然后保存(control-S)文件并构建。 Javadocs 现在看起来就像我想要的那样。谢谢沙拉!

Answer 1

如果 Javadoc 无法链接到类/方法/等，则它会输出完全限定名称。为了让它只输出简单的名称，您必须链接到外部 Javadoc。这是通过 -link <url> 完成的javadoc 的命令行选项工具。要链接到 SE 类(即 java.* 和 javax.* )，一种选择是使用:

javadoc -link https://docs.oracle.com/en/java/javase/11/docs/api/ [...]

哪里[...]是命令行的其余部分。您可以更改 URL 以指向不同版本的 Java(例如 Java 8 而不是 Java 11)。

还有一个-linkoffline <url1> <url2>选项。

注意:我相信“标准 doclet”提供了这两个选项。如果不使用标准 doclet，这些选项可能不可用或工作方式可能不同。