Question

我有一个java文件。我想用java文档来处理方法等。如果我的一些方法使用java类或接口，例如： Collection<MyClass> names = new ArrayList<>();如何链接原始java.util文档的Collection或ArrayList？

例如：如果我为Javadoc生成以下代码，它将出现在HTML中 doc，但没有链接到java.util的ArrayList。

/**
 * The constructor using with {@link Collection} - interface and {@link ArrayList} - class for initialize....
 *
 */
public myConstructor(){
   names = new ArrayList<>();
   ........
}

感谢您的帮助。

Answer 1

您需要通过-link命令行选项将其他外部文档传递给javadoc工具，例如-link https://docs.oracle.com/javase/8/docs/api/。

如果导入类或完全限定类，则应插入链接。

示例：

import java.util.Collection;

/**
 * {@link java.util.ArrayList} is a {@link Collection}.
 */
public class MyClass {
}

javadoc -link https://docs.oracle.com/javase/8/docs/api/ MyClass.java

结果的相关部分：

＆＃13;

<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util"><code>ArrayList</code></a> is a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>.

＆＃13;

如何使用java.util的链接创建文档（原始文档）

1 个答案: